From 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Sun, 12 Jul 2026 17:11:17 +0800 Subject: update APIs 20260712 --- data/en_us/esa/2024-09-10/api-docs.php | 103474 +++++++----------------------- 1 file changed, 24252 insertions(+), 79222 deletions(-) (limited to 'data/en_us/esa') diff --git a/data/en_us/esa/2024-09-10/api-docs.php b/data/en_us/esa/2024-09-10/api-docs.php index ccfd17b..0f11d36 100644 --- a/data/en_us/esa/2024-09-10/api-docs.php +++ b/data/en_us/esa/2024-09-10/api-docs.php @@ -1,64 +1,55 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'ESA', - 'version' => '2024-09-10', - ], + 'info' => ['style' => 'RPC', 'product' => 'ESA', 'version' => '2024-09-10'], 'directories' => [ [ 'children' => [ [ - 'children' => [ - 'GetSite', - 'ListSites', - ], + 'children' => ['CreateSite', 'CheckSiteName'], 'type' => 'directory', - 'title' => 'Query website', + 'title' => 'Add and verify sites', ], [ - 'children' => [ - 'TagResources', - ], + 'children' => ['GetSite', 'ListSites'], + 'type' => 'directory', + 'title' => 'Query sites', + ], + [ + 'children' => ['DeleteSite', 'UpdateSiteCoverage'], 'type' => 'directory', - 'title' => 'Manage tags', + 'title' => 'Update and delete sites', ], ], 'type' => 'directory', - 'title' => 'Website management', + 'title' => 'Site management', ], [ 'children' => [ [ 'children' => [ [ - 'children' => [ - 'CreateCustomHostname', - 'DeleteCustomHostname', - 'UpdateCustomHostname', - 'VerifyCustomHostname', - 'GetCustomHostname', - 'ListCustomHostnames', - 'ApplyCustomHostnameCertificate', - ], + 'children' => ['UpdateSitePause', 'GetSitePause'], + 'type' => 'directory', + 'title' => 'Site suspension', + ], + ], + 'type' => 'directory', + 'title' => 'Site status', + ], + [ + 'children' => [ + [ + 'children' => ['CreateCustomHostname', 'DeleteCustomHostname', 'UpdateCustomHostname', 'VerifyCustomHostname', 'GetCustomHostname', 'ListCustomHostnames', 'ApplyCustomHostnameCertificate'], 'type' => 'directory', 'title' => 'SaaS domain names', ], [ - 'children' => [ - 'BatchCreateRecords', - 'DeleteRecord', - 'UpdateRecord', - 'ListRecords', - 'GetRecord', - ], + 'children' => ['BatchCreateRecords', 'DeleteRecord', 'UpdateRecord', 'ListRecords', 'GetRecord', 'ListEdgeRoutineRecords', 'ExportRecords'], 'type' => 'directory', 'title' => 'DNS records', ], [ - 'children' => [ - 'UpdateCnameFlattening', - ], + 'children' => ['UpdateCnameFlattening'], 'type' => 'directory', 'title' => 'CNAME flattening', ], @@ -69,43 +60,25 @@ [ 'children' => [ [ - 'children' => [ - 'ApplyCertificate', - 'SetCertificate', - 'GetCertificate', - 'ListCertificates', - 'ListCertificatesByRecord', - ], + 'children' => ['ApplyCertificate', 'SetCertificate', 'ListCertificatesByRecord', 'GetCertificateQuota', 'ListCertificates', 'GetCertificate'], 'type' => 'directory', - 'title' => 'Website certificates', + 'title' => 'Site certificates', ], [ - 'children' => [ - 'ListClientCaCertificates', - 'SetClientCertificateHostnames', - ], + 'children' => ['GetClientCaCertificate', 'ListClientCaCertificates', 'GetClientCertificate', 'ListClientCertificates', 'SetClientCertificateHostnames', 'GetClientCertificateHostnames', 'SetClientCaCertificateHostnames', 'GetClientCaCertificateHostnames'], 'type' => 'directory', 'title' => 'Client certificates', ], [ - 'children' => [ - 'UploadOriginCaCertificate', - 'GetOriginCaCertificate', - 'DeleteOriginCaCertificate', - 'ListOriginCaCertificates', - 'GetSiteOriginClientCertificate', - 'DeleteSiteOriginClientCertificate', - 'ListSiteOriginClientCertificates', - 'UploadOriginClientCertificate', - 'GetOriginClientCertificate', - 'DeleteOriginClientCertificate', - 'ListOriginClientCertificates', - 'SetOriginClientCertificateHostnames', - 'GetOriginClientCertificateHostnames', - ], + 'children' => ['UploadOriginCaCertificate', 'GetOriginCaCertificate', 'DeleteOriginCaCertificate', 'ListOriginCaCertificates', 'GetSiteOriginClientCertificate', 'DeleteSiteOriginClientCertificate', 'ListSiteOriginClientCertificates', 'UploadOriginClientCertificate', 'GetOriginClientCertificate', 'DeleteOriginClientCertificate', 'ListOriginClientCertificates', 'SetOriginClientCertificateHostnames', 'GetOriginClientCertificateHostnames'], 'type' => 'directory', 'title' => 'Origin certificates', ], + [ + 'children' => ['SetKeylessServer', 'GetKeylessServer', 'ListKeylessServers', 'DeleteKeylessServer'], + 'type' => 'directory', + 'title' => 'Keyless service', + ], ], 'type' => 'directory', 'title' => 'SSL/TLS', @@ -113,62 +86,68 @@ [ 'children' => [ [ - 'children' => [ - 'ListWafRules', - 'ListWafTemplateRules', - 'ListWafManagedRules', - 'GetWafQuota', - 'GetWafFilter', - ], + 'children' => ['SetAutomaticFrequencyControlConfig', 'GetAutomaticFrequencyControlConfig'], + 'type' => 'directory', + 'title' => 'Intelligent rate limiting', + ], + [ + 'children' => ['CreateWafRule', 'CreateWafRuleset', 'BatchCreateWafRules', 'GetWafRule', 'GetWafRuleset', 'ListWafRules', 'ListWafRulesets', 'UpdateWafRule', 'UpdateWafRuleset', 'BatchUpdateWafRules', 'DeleteWafRule', 'DeleteWafRuleset', 'ListWafTemplateRules', 'ListWafManagedRules', 'ListWafUsageOfRules', 'GetWafQuota', 'GetWafFilter', 'GetSiteWafSettings', 'EditSiteWafSettings', 'BatchGetExpressionFields'], 'type' => 'directory', 'title' => 'WAF', ], [ - 'children' => [ - 'SetHttpDDoSAttackRuleStatus', - 'SetHttpDDoSAttackRuleAction', - 'DescribeHttpDDoSAttackRules', - 'DescribeDDoSAllEventList', - 'SetDdosMaxBurstGbps', - 'DescribeDdosMaxBurstGbps', - 'DeleteHttpDDoSIntelligentRule', - 'DescribeHttpDDoSIntelligentRateLimitRules', - 'DescribeHttpDDoSIntelligentAclRules', - ], + 'children' => ['SetHttpDDoSAttackRuleStatus', 'SetHttpDDoSAttackRuleAction', 'DescribeHttpDDoSAttackRules', 'DescribeDDoSAllEventList', 'SetDdosMaxBurstGbps', 'DescribeDdosMaxBurstGbps', 'SetHttpDDoSAttackIntelligentProtection', 'DeleteHttpDDoSIntelligentRule', 'DescribeHttpDDoSAttackIntelligentProtection', 'DescribeHttpDDoSIntelligentRateLimitRules', 'DescribeHttpDDoSIntelligentAclRules'], 'type' => 'directory', 'title' => 'DDoS', ], [ - 'children' => [ - 'GetApiSchemaUsage', - ], + 'children' => ['GetApiSchemaUsage'], 'type' => 'directory', 'title' => 'API security', ], [ - 'children' => [ - 'GetOriginProtection', - ], + 'children' => ['CreateOriginProtection', 'DeleteOriginProtection', 'UpdateOriginProtection', 'UpdateOriginProtectionIpWhiteList', 'GetOriginProtection'], 'type' => 'directory', 'title' => 'Origin protection', ], ], 'type' => 'directory', - 'title' => 'Security', + 'title' => 'Security protection', ], [ 'children' => [ [ - 'children' => [ - 'ListScheduledPreloadJobs', - ], + 'children' => ['DescribePurgeTasks', 'GetPurgeQuota'], + 'type' => 'directory', + 'title' => 'Purge cache', + ], + [ + 'children' => ['UpdateCacheTag'], + 'type' => 'directory', + 'title' => 'Cache tags', + ], + [ + 'children' => ['DescribePreloadTasks'], + 'type' => 'directory', + 'title' => 'Prefetch cache', + ], + [ + 'children' => ['CreateScheduledPreloadJob', 'CreateScheduledPreloadExecutions', 'StartScheduledPreloadExecution', 'StopScheduledPreloadExecution', 'DeleteScheduledPreloadExecution', 'DeleteScheduledPreloadJob', 'UpdateScheduledPreloadExecution', 'ResetScheduledPreloadJob', 'GetScheduledPreloadJob', 'ListScheduledPreloadJobs', 'ListScheduledPreloadExecutions'], 'type' => 'directory', 'title' => 'Scheduled prefetch', ], [ - 'children' => [ - 'UpdateCacheReserveSpec', - ], + 'children' => ['BlockObject'], + 'type' => 'directory', + 'title' => 'Content blocking', + ], + [ + 'children' => ['UpdateTieredCache'], + 'type' => 'directory', + 'title' => 'Tiered cache', + ], + [ + 'children' => ['ListCacheReserveInstances', 'UpdateCacheReserveSpec'], 'type' => 'directory', 'title' => 'Cache reserve', ], @@ -179,187 +158,105 @@ [ 'children' => [ [ - 'children' => [ - 'CreateHttpsBasicConfiguration', - 'UpdateHttpsBasicConfiguration', - ], + 'children' => ['CreateHttpsBasicConfiguration', 'UpdateHttpsBasicConfiguration', 'ListHttpsBasicConfigurations'], 'type' => 'directory', - 'title' => 'SSL and TLS rules', + 'title' => 'SSL/TLS rules', ], [ - 'children' => [ - 'CreateHttpsApplicationConfiguration', - 'UpdateHttpsApplicationConfiguration', - 'GetHttpsApplicationConfiguration', - 'ListHttpsApplicationConfigurations', - ], + 'children' => ['CreateHttpsApplicationConfiguration', 'UpdateHttpsApplicationConfiguration', 'GetHttpsApplicationConfiguration', 'ListHttpsApplicationConfigurations'], 'type' => 'directory', 'title' => 'HTTPS rules', ], [ - 'children' => [ - 'CreateRedirectRule', - 'UpdateRedirectRule', - ], + 'children' => ['CreateRedirectRule', 'UpdateRedirectRule'], 'type' => 'directory', 'title' => 'Redirect rules', ], [ - 'children' => [ - 'CreateRewriteUrlRule', - 'UpdateRewriteUrlRule', - ], + 'children' => ['CreateRewriteUrlRule', 'UpdateRewriteUrlRule'], 'type' => 'directory', 'title' => 'Rewrite URL', ], [ - 'children' => [ - 'CreateHttpRequestHeaderModificationRule', - 'UpdateHttpRequestHeaderModificationRule', - 'GetHttpRequestHeaderModificationRule', - 'ListHttpRequestHeaderModificationRules', - ], + 'children' => ['CreateHttpRequestHeaderModificationRule', 'UpdateHttpRequestHeaderModificationRule', 'GetHttpRequestHeaderModificationRule', 'ListHttpRequestHeaderModificationRules'], 'type' => 'directory', - 'title' => 'Modify Request Header', + 'title' => 'Modify outbound request headers (ESA to origin)', ], [ - 'children' => [ - 'CreateHttpIncomingRequestHeaderModificationRule', - 'UpdateHttpIncomingRequestHeaderModificationRule', - 'GetHttpIncomingRequestHeaderModificationRule', - 'ListHttpIncomingRequestHeaderModificationRules', - 'DeleteHttpIncomingRequestHeaderModificationRule', - ], + 'children' => ['CreateHttpIncomingRequestHeaderModificationRule', 'UpdateHttpIncomingRequestHeaderModificationRule', 'GetHttpIncomingRequestHeaderModificationRule', 'ListHttpIncomingRequestHeaderModificationRules', 'DeleteHttpIncomingRequestHeaderModificationRule'], 'type' => 'directory', - 'title' => 'Modify incoming request header (client to ESA)', + 'title' => 'Modify inbound request headers (client to ESA)', ], [ - 'children' => [ - 'CreateHttpResponseHeaderModificationRule', - 'UpdateHttpResponseHeaderModificationRule', - 'GetHttpResponseHeaderModificationRule', - 'ListHttpResponseHeaderModificationRules', - ], + 'children' => ['CreateHttpResponseHeaderModificationRule', 'UpdateHttpResponseHeaderModificationRule', 'GetHttpResponseHeaderModificationRule', 'ListHttpResponseHeaderModificationRules'], 'type' => 'directory', - 'title' => 'Modify Response Header', + 'title' => 'Modify outbound response headers (ESA to client)', ], [ - 'children' => [ - 'CreateHttpIncomingResponseHeaderModificationRule', - 'UpdateHttpIncomingResponseHeaderModificationRule', - 'GetHttpIncomingResponseHeaderModificationRule', - 'ListHttpIncomingResponseHeaderModificationRules', - 'DeleteHttpIncomingResponseHeaderModificationRule', - ], + 'children' => ['CreateHttpIncomingResponseHeaderModificationRule', 'UpdateHttpIncomingResponseHeaderModificationRule', 'GetHttpIncomingResponseHeaderModificationRule', 'ListHttpIncomingResponseHeaderModificationRules', 'DeleteHttpIncomingResponseHeaderModificationRule'], 'type' => 'directory', - 'title' => 'Modify incoming response header (client to ESA)', + 'title' => 'Modify inbound response headers (origin to ESA)', ], [ - 'children' => [ - 'CreateCustomResponseCodeRule', - 'UpdateCustomResponseCodeRule', - 'DeleteCustomResponseCodeRule', - 'GetCustomResponseCodeRule', - 'ListCustomResponseCodeRules', - ], + 'children' => ['CreateCustomResponseCodeRule', 'UpdateCustomResponseCodeRule', 'DeleteCustomResponseCodeRule', 'GetCustomResponseCodeRule', 'ListCustomResponseCodeRules'], 'type' => 'directory', 'title' => 'Custom response codes', ], [ - 'children' => [ - 'UpdateManagedTransform', - 'GetManagedTransform', - ], + 'children' => ['UpdateManagedTransform', 'GetManagedTransform'], 'type' => 'directory', - 'title' => 'Managed Transform', + 'title' => 'Managed transforms', ], [ - 'children' => [ - 'CreateCacheRule', - 'UpdateCacheRule', - 'GetCacheRule', - 'ListCacheRules', - ], + 'children' => ['CreateCacheRule', 'UpdateCacheRule', 'GetCacheRule', 'ListCacheRules'], 'type' => 'directory', 'title' => 'Cache rules', ], [ - 'children' => [ - 'CreateNetworkOptimization', - 'UpdateNetworkOptimization', - ], + 'children' => ['CreateNetworkOptimization', 'UpdateNetworkOptimization'], 'type' => 'directory', 'title' => 'Network optimization rules', ], [ - 'children' => [ - 'CreateCompressionRule', - 'UpdateCompressionRule', - ], + 'children' => ['CreateCompressionRule', 'UpdateCompressionRule'], 'type' => 'directory', 'title' => 'File compression', ], [ - 'children' => [ - 'CreateImageTransform', - 'UpdateImageTransform', - ], + 'children' => ['CreateImageTransform', 'UpdateImageTransform', 'GetImageTransform', 'ListImageTransforms'], 'type' => 'directory', 'title' => 'Image processing', ], [ - 'children' => [ - 'CreateVideoProcessing', - 'UpdateVideoProcessing', - 'GetVideoProcessing', - 'ListVideoProcessings', - 'DeleteVideoProcessing', - ], + 'children' => ['CreateVideoProcessing', 'UpdateVideoProcessing', 'GetVideoProcessing', 'ListVideoProcessings', 'DeleteVideoProcessing'], 'type' => 'directory', 'title' => 'Video processing', ], [ - 'children' => [ - 'CreateOriginRule', - 'UpdateOriginRule', - 'GetOriginRule', - 'ListOriginRules', - ], + 'children' => ['CreateOriginRule', 'UpdateOriginRule', 'GetOriginRule', 'ListOriginRules'], 'type' => 'directory', - 'title' => 'Origin rules', + 'title' => 'Back-to-origin rules', ], ], 'type' => 'directory', - 'title' => 'Rule configuration', + 'title' => 'Rules', ], [ 'children' => [ [ - 'children' => [ - 'UpdateIPv6', - 'GetIPv6', - ], + 'children' => ['UpdateIPv6', 'GetIPv6'], 'type' => 'directory', 'title' => 'IPv6', ], [ - 'children' => [ - 'CreateUrlObservation', - 'UpdateUrlObservation', - 'DescribeUrlObservationData', - 'ListUrlObservations', - 'DeleteUrlObservation', - ], + 'children' => ['CreateUrlObservation', 'UpdateUrlObservation', 'DescribeUrlObservationData', 'ListUrlObservations', 'DeleteUrlObservation'], 'type' => 'directory', - 'title' => 'URL Observation', + 'title' => 'Web page monitoring', ], [ - 'children' => [ - 'GetCrossBorderOptimization', - 'UpdateCrossBorderOptimization', - ], + 'children' => ['GetCrossBorderOptimization', 'UpdateCrossBorderOptimization'], 'type' => 'directory', - 'title' => 'Chinese mainland network optimization', + 'title' => 'Chinese mainland network - access optimization', ], ], 'type' => 'directory', @@ -368,19 +265,17 @@ [ 'children' => [ [ - 'children' => [ - 'UpdateSeoBypass', - ], + 'children' => ['CreateWaitingRoom', 'UpdateWaitingRoom', 'ListWaitingRooms', 'CreateWaitingRoomEvent', 'UpdateWaitingRoomEvent', 'ListWaitingRoomEvents', 'UpdateSeoBypass'], 'type' => 'directory', 'title' => 'Waiting room', ], [ - 'children' => [ - 'CreateLoadBalancer', - 'UpdateLoadBalancer', - 'GetLoadBalancer', - 'ListLoadBalancers', - ], + 'children' => ['CreateOriginPool', 'UpdateOriginPool', 'GetOriginPool', 'ListOriginPools'], + 'type' => 'directory', + 'title' => 'Origin address pools', + ], + [ + 'children' => ['CreateLoadBalancer', 'UpdateLoadBalancer', 'GetLoadBalancer', 'ListLoadBalancers', 'ListLoadBalancerRegions'], 'type' => 'directory', 'title' => 'Load balancing', ], @@ -389,90 +284,84 @@ 'title' => 'Traffic', ], [ - 'children' => [ - 'CreateTransportLayerApplication', - 'UpdateTransportLayerApplication', - 'GetTransportLayerApplication', - 'ListTransportLayerApplications', - 'DeleteTransportLayerApplication', - ], + 'children' => ['CreateTransportLayerApplication', 'UpdateTransportLayerApplication', 'GetTransportLayerApplication', 'ListTransportLayerApplications', 'DeleteTransportLayerApplication'], 'type' => 'directory', 'title' => 'Layer 4 proxy', ], [ - 'children' => [ - 'ListSiteRoutes', - ], + 'children' => ['ListSiteRoutes'], 'type' => 'directory', - 'title' => 'Routine route', + 'title' => 'Function routing', ], ], 'type' => 'directory', - 'title' => 'Website configuration', + 'title' => 'Site configuration', ], [ 'children' => [ [ 'children' => [ - 'ListUserRoutines', - 'CreateRoutine', - 'GetRoutine', - 'CreateRoutineRoute', - 'UpdateRoutineRoute', - 'GetRoutineRoute', - 'ListRoutineRoutes', - 'DeleteRoutineRoute', - 'CreateRoutineCodeDeployment', - 'GetRoutineCodeVersion', - 'ListRoutineCodeVersions', - 'UpdateRoutineConfigDescription', - 'CreateRoutineRelatedRecord', - 'ListRoutineRelatedRecords', + [ + 'children' => ['CreateRoutine', 'ListUserRoutines', 'GetRoutine', 'UpdateRoutineConfigDescription'], + 'type' => 'directory', + 'title' => 'Function management', + ], + [ + 'children' => ['CreateRoutineRoute', 'UpdateRoutineRoute', 'DeleteRoutineRoute', 'ListRoutineRoutes', 'GetRoutineRoute'], + 'type' => 'directory', + 'title' => 'Function routing', + ], + [ + 'children' => ['CreateRoutineRelatedRecord', 'ListRoutineRelatedRecords'], + 'type' => 'directory', + 'title' => 'Function-associated host records', + ], + [ + 'children' => ['CommitRoutineStagingCode', 'ListRoutineCodeVersions', 'GetRoutineCodeVersion', 'CreateRoutineCodeDeployment'], + 'type' => 'directory', + 'title' => 'Function code versions', + ], ], 'type' => 'directory', - 'title' => 'Edge routine', + 'title' => 'Edge functions', ], [ 'children' => [ [ - 'children' => [ - 'UpdateEdgeContainerAppResourceReserve', - 'GetEdgeContainerAppResourceReserve', - 'DescribeEdgeContainerAppStats', - 'GetEdgeContainerAppResourceStatus', - 'GetEdgeContainerAppResourceCapacity', - ], + 'children' => ['DeleteEdgeContainerApp', 'UpdateEdgeContainerAppResourceReserve', 'GetEdgeContainerAppResourceReserve', 'DescribeEdgeContainerAppStats', 'GetEdgeContainerAppResourceStatus', 'GetEdgeContainerAppResourceCapacity'], 'type' => 'directory', - 'title' => 'Container management', + 'title' => 'Container applications', ], [ - 'children' => [ - 'CreateEdgeContainerAppImageSecret', - 'ListEdgeContainerAppImageSecrets', - 'DeleteEdgeContainerAppImageSecret', - ], + 'children' => ['CreateEdgeContainerAppImageSecret', 'ListEdgeContainerAppImageSecrets', 'DeleteEdgeContainerAppImageSecret'], 'type' => 'directory', - 'title' => 'Container app image secret', + 'title' => 'Container application image secrets', ], [ - 'children' => [ - 'RollbackEdgeContainerAppVersion', - ], + 'children' => ['CreateEdgeContainerAppVersion', 'GetEdgeContainerAppVersion', 'PublishEdgeContainerAppVersion', 'RollbackEdgeContainerAppVersion'], 'type' => 'directory', 'title' => 'Version management', ], ], 'type' => 'directory', - 'title' => 'Edge container', + 'title' => 'Edge containers', ], [ 'children' => [ [ - 'children' => [ - 'GetKvDetail', - ], + 'children' => ['DescribeKvAccountStatus', 'GetKvAccount'], + 'type' => 'directory', + 'title' => 'Service status query', + ], + [ + 'children' => ['GetKvDetail', 'ListKvs', 'GetKv', 'PutKv', 'DeleteKv', 'BatchPutKv', 'BatchDeleteKv', 'PutKvWithHighCapacity', 'BatchPutKvWithHighCapacity', 'BatchDeleteKvWithHighCapacity'], 'type' => 'directory', - 'title' => 'Key value settings', + 'title' => 'Key-value pair settings', + ], + [ + 'children' => ['CreateKvNamespace', 'DeleteKvNamespace', 'GetKvNamespace'], + 'type' => 'directory', + 'title' => 'Storage space', ], ], 'type' => 'directory', @@ -485,297 +374,96 @@ [ 'children' => [ [ - 'children' => [ - 'DescribeSiteTimeSeriesData', - 'DescribeSiteTopData', - ], + 'children' => ['DescribeSiteTimeSeriesData', 'DescribeSiteTopData'], 'type' => 'directory', 'title' => 'Data analytics', ], [ - 'children' => [ - 'DescribeSiteLogs', - ], + 'children' => ['CreateSiteDeliveryTask', 'UpdateSiteDeliveryTask', 'UpdateUserDeliveryTaskStatus', 'GetSiteLogDeliveryQuota', 'CreateUserDeliveryTask', 'UpdateUserDeliveryTask', 'GetUserDeliveryTask', 'GetSiteDeliveryTask'], + 'type' => 'directory', + 'title' => 'Real-time logs', + ], + [ + 'children' => ['DescribeSiteLogs'], 'type' => 'directory', - 'title' => 'Standard log', + 'title' => 'Offline logs', ], ], 'type' => 'directory', - 'title' => 'Analysis and log', + 'title' => 'Analytics and logs', ], [ 'children' => [ [ - 'children' => [ - 'CreateUserWafRuleset', - 'DeleteUserWafRuleset', - 'GetUserWafRuleset', - 'ListUserWafRulesets', - 'UpdateUserWafRuleset', - ], + 'children' => ['CreateUserWafRuleset', 'DeleteUserWafRuleset', 'GetUserWafRuleset', 'ListUserWafRulesets', 'UpdateUserWafRuleset'], 'type' => 'directory', 'title' => 'Global WAF', ], [ - 'children' => [ - 'ListLists', - ], + 'children' => ['GetList', 'ListLists'], 'type' => 'directory', - 'title' => 'Grouping', + 'title' => 'Groups', ], [ - 'children' => [ - 'CreateCustomScenePolicy', - 'UpdateCustomScenePolicy', - 'DescribeCustomScenePolicies', - ], + 'children' => ['CreateCustomScenePolicy', 'UpdateCustomScenePolicy', 'DescribeCustomScenePolicies'], 'type' => 'directory', - 'title' => 'Scenario policy', + 'title' => 'Scenario-specific policies', ], [ - 'children' => [ - 'ListPages', - ], + 'children' => ['CreatePage', 'UpdatePage', 'GetPage', 'ListPages'], 'type' => 'directory', - 'title' => 'Customize page', + 'title' => 'Custom pages', ], ], 'type' => 'directory', - 'title' => 'Global settings ', + 'title' => 'Global configuration', + ], + [ + 'children' => ['TagResources'], + 'type' => 'directory', + 'title' => 'Tag management', ], [ 'children' => [ + [ + 'children' => ['ListTraceTasks', 'DescribeTraceDiagnoseReport', 'GenerateTraceDiagnose'], + 'type' => 'directory', + 'title' => 'Site diagnostics', + ], 'ListESAIPInfo', - 'ActivateClientCertificate', - 'ActivateVersionManagement', - 'BatchCreateWafRules', - 'BatchDeleteKv', - 'BatchDeleteKvWithHighCapacity', - 'BatchGetExpressionFields', - 'BatchPutKv', - 'BatchPutKvWithHighCapacity', - 'BatchUpdateWafRules', - 'BlockObject', - 'CheckSiteName', - 'CheckSiteProjectName', - 'CheckUserProjectName', - 'CommitRoutineStagingCode', - 'CreateClientCertificate', - 'CreateEdgeContainerApp', - 'CreateEdgeContainerAppRecord', - 'CreateEdgeContainerAppVersion', - 'CreateKvNamespace', - 'CreateList', - 'CreateOriginPool', - 'CreateOriginProtection', - 'CreatePage', - 'CreateRecord', - 'CreateScheduledPreloadExecutions', - 'CreateScheduledPreloadJob', - 'CreateSite', - 'CreateSiteCustomLog', - 'CreateSiteDeliveryTask', - 'CreateUserDeliveryTask', - 'CreateWafRule', - 'CreateWafRuleset', - 'CreateWaitingRoom', - 'CreateWaitingRoomEvent', - 'CreateWaitingRoomRule', - 'DeactivateVersionManagement', - 'DeleteCacheRule', - 'DeleteCertificate', - 'DeleteClientCaCertificate', - 'DeleteClientCertificate', - 'DeleteCompressionRule', - 'DeleteCustomScenePolicy', - 'DeleteEdgeContainerApp', - 'DeleteEdgeContainerAppRecord', - 'DeleteEdgeContainerAppVersion', - 'DeleteHttpRequestHeaderModificationRule', - 'DeleteHttpResponseHeaderModificationRule', - 'DeleteHttpsApplicationConfiguration', - 'DeleteHttpsBasicConfiguration', - 'DeleteImageTransform', - 'DeleteKv', - 'DeleteKvNamespace', - 'DeleteList', - 'DeleteLoadBalancer', - 'DeleteNetworkOptimization', - 'DeleteOriginPool', - 'DeleteOriginProtection', - 'DeleteOriginRule', - 'DeletePage', - 'DeleteRedirectRule', - 'DeleteRewriteUrlRule', - 'DeleteRoutine', - 'DeleteRoutineCodeVersion', - 'DeleteRoutineRelatedRecord', - 'DeleteScheduledPreloadExecution', - 'DeleteScheduledPreloadJob', - 'DeleteSite', - 'DeleteSiteDeliveryTask', - 'DeleteUserDeliveryTask', - 'DeleteWafRule', - 'DeleteWafRuleset', - 'DeleteWaitingRoom', - 'DeleteWaitingRoomEvent', - 'DeleteWaitingRoomRule', - 'DescribeDDoSBpsList', - 'DescribeDDoSL7QpsList', - 'DescribeHttpDDoSAttackIntelligentProtection', - 'DescribeHttpDDoSAttackProtection', - 'DescribeKvAccountStatus', - 'DescribePreloadTasks', - 'DescribePurgeTasks', - 'DescribeRatePlanInstanceStatus', - 'DisableCustomScenePolicy', - 'EditSiteWafSettings', - 'EnableCustomScenePolicy', - 'ExportRecords', - 'GetCacheReserveSpecification', - 'GetCacheTag', - 'GetCertificateQuota', - 'GetClientCaCertificate', - 'GetClientCertificate', - 'GetClientCertificateHostnames', - 'GetCnameFlattening', - 'GetCompressionRule', - 'GetDevelopmentMode', - 'GetEdgeContainerApp', - 'GetEdgeContainerAppLogRiver', - 'GetEdgeContainerAppStatus', - 'GetEdgeContainerAppVersion', - 'GetEdgeContainerDeployRegions', - 'GetEdgeContainerLogs', - 'GetEdgeContainerStagingDeployStatus', - 'GetEdgeContainerTerminal', - 'GetErService', - 'GetHttpsBasicConfiguration', - 'GetImageTransform', - 'GetKv', - 'GetKvAccount', - 'GetKvNamespace', - 'GetList', - 'GetNetworkOptimization', - 'GetOriginPool', - 'GetPage', - 'GetPurgeQuota', - 'GetRealtimeDeliveryField', - 'GetRedirectRule', - 'GetRewriteUrlRule', - 'GetRoutineStagingCodeUploadInfo', - 'GetScheduledPreloadJob', - 'GetSeoBypass', - 'GetSiteCurrentNS', - 'GetSiteCustomLog', - 'GetSiteDeliveryTask', - 'GetSiteLogDeliveryQuota', - 'GetSiteNameExclusive', - 'GetSitePause', - 'GetSiteWafSettings', - 'GetTieredCache', - 'GetUploadTask', - 'GetUserDeliveryTask', - 'GetUserLogDeliveryQuota', - 'GetWafBotAppKey', - 'GetWafRule', - 'GetWafRuleset', - 'ListCacheReserveInstances', - 'ListCiphers', - 'ListClientCertificates', - 'ListCompressionRules', - 'ListEdgeContainerAppRecords', - 'ListEdgeContainerAppVersions', - 'ListEdgeContainerApps', - 'ListEdgeContainerRecords', - 'ListEdgeRoutinePlans', - 'ListEdgeRoutineRecords', - 'ListHttpsBasicConfigurations', - 'ListImageTransforms', - 'ListInstanceQuotas', - 'ListInstanceQuotasWithUsage', - 'ListKvs', - 'ListLoadBalancerOriginStatus', - 'ListLoadBalancerRegions', - 'ListManagedRulesGroups', - 'ListNetworkOptimizations', - 'ListOriginPools', - 'ListRedirectRules', - 'ListRewriteUrlRules', - 'ListScheduledPreloadExecutions', - 'ListSiteDeliveryTasks', - 'ListTagResources', - 'ListUploadTasks', - 'ListUserDeliveryTasks', - 'ListUserRatePlanInstances', - 'ListWafPhases', - 'ListWafRulesets', - 'ListWafUsageOfRules', - 'ListWaitingRoomEvents', - 'ListWaitingRoomRules', - 'ListWaitingRooms', - 'OpenErService', - 'PreloadCaches', - 'PublishEdgeContainerAppVersion', - 'PurchaseCacheReserve', - 'PurgeCaches', - 'PutKv', - 'PutKvWithHighCapacity', - 'RebuildEdgeContainerAppStagingEnv', - 'ResetScheduledPreloadJob', - 'RevokeClientCertificate', - 'SetHttpDDoSAttackIntelligentProtection', - 'SetHttpDDoSAttackProtection', - 'StartScheduledPreloadExecution', - 'StopScheduledPreloadExecution', - 'UntagResources', - 'UpdateCacheTag', - 'UpdateDevelopmentMode', - 'UpdateEdgeContainerAppLogRiver', - 'UpdateList', - 'UpdateOriginPool', - 'UpdateOriginProtection', - 'UpdateOriginProtectionIpWhiteList', - 'UpdatePage', - 'UpdateScheduledPreloadExecution', - 'UpdateSiteAccessType', - 'UpdateSiteCoverage', - 'UpdateSiteCustomLog', - 'UpdateSiteDeliveryTask', - 'UpdateSiteDeliveryTaskStatus', - 'UpdateSiteNameExclusive', - 'UpdateSitePause', - 'UpdateSiteVanityNS', - 'UpdateTieredCache', - 'UpdateUserDeliveryTask', - 'UpdateUserDeliveryTaskStatus', - 'UpdateWafRule', - 'UpdateWafRuleset', - 'UpdateWaitingRoom', - 'UpdateWaitingRoomEvent', - 'UpdateWaitingRoomRule', - 'UploadClientCaCertificate', - 'UploadFile', - 'UploadSiteOriginClientCertificate', - 'VerifySite', ], 'type' => 'directory', - 'title' => 'Others', + 'title' => 'Tools', ], [ 'children' => [ [ - 'children' => [ - 'PurchaseRatePlan', - 'UpdateRatePlanSpec', - ], + 'children' => ['PurchaseRatePlan', 'UpdateRatePlanSpec', 'ListUserRatePlanInstances', 'ListPostpaidRatePlanInstances', 'DescribeRatePlanPrice'], + 'type' => 'directory', + 'title' => 'Plan instance management', + ], + [ + 'children' => ['ListDDoSInstances', 'ReleaseInstance'], 'type' => 'directory', - 'title' => 'Plan management', + 'title' => 'Security instance management', ], ], 'type' => 'directory', 'title' => 'Billing management', ], + [ + 'children' => [ + 'GetPerformanceDataCollection', 'UpdatePerformanceDataCollection', 'ActivateClientCertificate', 'ActivateVersionManagement', 'CheckSiteProjectName', 'CheckUserProjectName', 'CreateClientCertificate', 'CreateEdgeContainerApp', 'CreateEdgeContainerAppRecord', 'CreateList', 'CreateRecord', 'CreateSiteCustomLog', 'CreateWaitingRoomRule', 'DeactivateVersionManagement', 'DeleteCacheRule', 'DeleteCertificate', 'DeleteClientCaCertificate', 'DeleteClientCertificate', 'DeleteCompressionRule', 'DeleteCustomScenePolicy', + 'DeleteEdgeContainerAppRecord', 'DeleteEdgeContainerAppVersion', 'DeleteHttpRequestHeaderModificationRule', 'DeleteHttpResponseHeaderModificationRule', 'DeleteHttpsApplicationConfiguration', 'DeleteHttpsBasicConfiguration', 'DeleteImageTransform', 'DeleteList', 'DeleteLoadBalancer', 'DeleteNetworkOptimization', 'DeleteOriginPool', 'DeleteOriginRule', 'DeletePage', 'DeleteRedirectRule', 'DeleteRewriteUrlRule', 'DeleteRoutine', 'DeleteRoutineCodeVersion', 'DeleteRoutineRelatedRecord', 'DeleteSiteDeliveryTask', 'DeleteUserDeliveryTask', + 'DeleteWaitingRoom', 'DeleteWaitingRoomEvent', 'DeleteWaitingRoomRule', 'DescribeBotPrice', 'DescribeCacheReservePrice', 'DescribeCacheReservePriceGap', 'DescribeDDoSBpsList', 'DescribeDDoSBpsMax', 'DescribeDDoSEventMax', 'DescribeDDoSL7QpsList', 'DescribeDDoSOverseasAttackCount', 'DescribeHttpDDoSAttackProtection', 'DescribeRatePlanInstanceStatus', 'DescribeRatePlanPriceGap', 'DescribeSiteWafTimeSeriesData', 'DescribeSiteWafTopData', 'DescribeWafUsageData', 'DisableCustomScenePolicy', 'EnableCustomScenePolicy', 'GetCacheReserveSpecification', + 'GetCacheTag', 'GetCnameFlattening', 'GetCompressionRule', 'GetDcvDelegation', 'GetDevelopmentMode', 'GetEdgeContainer', 'GetEdgeContainerApp', 'GetEdgeContainerAppLogRiver', 'GetEdgeContainerAppStatus', 'GetEdgeContainerDeployRegions', 'GetEdgeContainerLogs', 'GetEdgeContainerStagingDeployStatus', 'GetEdgeContainerTerminal', 'GetErService', 'GetFailFile', 'GetHttpsBasicConfiguration', 'GetNetworkOptimization', 'GetRealtimeDeliveryField', 'GetRedirectRule', 'GetRewriteUrlRule', + 'GetRoutineCodeVersionInfo', 'GetRoutineStagingCodeUploadInfo', 'GetSeoBypass', 'GetSiteCurrentNS', 'GetSiteCustomLog', 'GetSiteNameExclusive', 'GetTieredCache', 'GetUploadTask', 'GetUserLogDeliveryQuota', 'GetWafBotAppKey', 'ListCasCertificates', 'ListCiphers', 'ListCompressionRules', 'ListEdgeContainerAppRecords', 'ListEdgeContainerAppVersions', 'ListEdgeContainerApps', 'ListEdgeContainerRecords', 'ListEdgeRoutinePlans', 'ListInstanceQuotas', 'ListInstanceQuotasWithUsage', + 'ListLoadBalancerOriginStatus', 'ListManagedRulesGroups', 'ListNetworkOptimizations', 'ListRedirectRules', 'ListRewriteUrlRules', 'ListSiteDeliveryTasks', 'ListTagResources', 'ListUploadTasks', 'ListUserDeliveryTasks', 'ListWafPhases', 'ListWaitingRoomRules', 'OpenEdgeContainer', 'OpenErService', 'PreloadCaches', 'PublishRoutineCodeVersion', 'PurchaseBotInstance', 'PurchaseCacheReserve', 'PurgeCaches', 'RebuildEdgeContainerAppStagingEnv', 'RevokeClientCertificate', + 'SetHttpDDoSAttackProtection', 'SubmitUploadTask', 'UntagResources', 'UpdateDevelopmentMode', 'UpdateEdgeContainerAppLogRiver', 'UpdateList', 'UpdateSiteAccessType', 'UpdateSiteCustomLog', 'UpdateSiteDeliveryTaskStatus', 'UpdateSiteNameExclusive', 'UpdateSiteVanityNS', 'UpdateWaitingRoomRule', 'UploadClientCaCertificate', 'UploadFile', 'UploadSiteOriginClientCertificate', 'VerifySite', + ], + 'type' => 'directory', + 'title' => 'Others', + ], ], 'components' => [ 'schemas' => [ @@ -785,54 +473,12 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Target' => [ - 'title' => '防护目标类型：web/app', - 'description' => 'Protection type: web or app.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'web', - 'backendName' => 'target', - ], - 'Mode' => [ - 'title' => 'web sdk 集成方式：自动集成(automatic)/手动集成(manual)', - 'description' => 'Web SDK integration method: automatic integration (automatic) or manual integration (manual).'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'automatic', - 'backendName' => 'mode', - ], - 'CrossSiteId' => [ - 'title' => '指定跨域站点id', - 'description' => 'Specifies the cross-domain website ID.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000001', - 'backendName' => 'crossSiteId', - ], - 'Name' => [ - 'title' => '规则集名称', - 'description' => 'The ruleset name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'example', - 'backendName' => 'name', - ], - 'Match' => [ - 'title' => '匹配引擎', - 'description' => 'The matching rule.'."\n", - 'visibility' => 'Public', - 'backendName' => 'match', - '$ref' => '#/components/schemas/WafRuleMatch2', - ], - 'Action' => [ - 'title' => '动作', - 'description' => 'The action that you want WAF to perform on requests that match the rule.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'deny', - 'backendName' => 'action', - ], + 'Target' => ['title' => '防护目标类型：web/app', 'description' => 'Protection type: web or app.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'web', 'backendName' => 'target'], + 'Mode' => ['title' => 'web sdk 集成方式：自动集成(automatic)/手动集成(manual)', 'description' => 'Web SDK integration method: automatic integration (automatic) or manual integration (manual).'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'automatic', 'backendName' => 'mode'], + 'CrossSiteId' => ['title' => '指定跨域站点id', 'description' => 'Specifies the cross-domain website ID.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '10000001', 'backendName' => 'crossSiteId'], + 'Name' => ['title' => '规则集名称', 'description' => 'The ruleset name.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'example', 'backendName' => 'name'], + 'Match' => ['title' => '匹配引擎', 'description' => 'The matching rule.'."\n", 'visibility' => 'Public', 'backendName' => 'match', '$ref' => '#/components/schemas/WafRuleMatch2'], + 'Action' => ['title' => '动作', 'description' => 'The action that you want WAF to perform on requests that match the rule.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'deny', 'backendName' => 'action'], 'Actions' => [ 'title' => '动作扩展', 'description' => 'The extended action configurations.'."\n", @@ -845,38 +491,15 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '自定义响应页面id', - 'description' => 'The ID of the custom response page.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50000001', - 'backendName' => 'id', - ], - 'Code' => [ - 'title' => '自定义响应码', - 'description' => 'The custom response code.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '403', - 'backendName' => 'code', - ], + 'Id' => ['title' => '自定义响应页面id', 'description' => 'The ID of the custom response page.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '50000001', 'backendName' => 'id'], + 'Code' => ['title' => '自定义响应码', 'description' => 'The custom response code.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '403', 'backendName' => 'code'], ], 'backendName' => 'response', ], ], 'backendName' => 'actions', ], - 'Expression' => [ - 'title' => '表达式', - 'description' => 'The expression.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ip.src eq 1.1.1.1', - 'backendName' => 'expression', - ], + 'Expression' => ['title' => '表达式', 'description' => 'The expression.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'ip.src eq 1.1.1.1', 'backendName' => 'expression'], ], ], 'WafQuotaInteger' => [ @@ -885,51 +508,11 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Equal' => [ - 'title' => 'equal', - 'description' => '等于。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'backendName' => 'eq', - 'example' => '1', - ], - 'GreaterThan' => [ - 'title' => 'greater than', - 'description' => '大于。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'backendName' => 'gt', - 'example' => '1', - ], - 'GreaterThanOrEqual' => [ - 'title' => 'greater than or equal', - 'description' => '大于等于。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'backendName' => 'ge', - 'example' => '1', - ], - 'LessThan' => [ - 'title' => 'less than', - 'description' => '小于。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'backendName' => 'lt', - 'example' => '1', - ], - 'LessThanOrEqual' => [ - 'title' => 'less than or equal', - 'description' => '小于等于。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'backendName' => 'le', - 'example' => '1', - ], + 'Equal' => ['title' => 'equal', 'description' => '等于。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'eq', 'example' => '1'], + 'GreaterThan' => ['title' => 'greater than', 'description' => '大于。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'gt', 'example' => '1'], + 'GreaterThanOrEqual' => ['title' => 'greater than or equal', 'description' => '大于等于。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'ge', 'example' => '1'], + 'LessThan' => ['title' => 'less than', 'description' => '小于。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'lt', 'example' => '1'], + 'LessThanOrEqual' => ['title' => 'less than or equal', 'description' => '小于等于。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'backendName' => 'le', 'example' => '1'], ], ], 'WafQuotaString' => [ @@ -938,15 +521,65 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Regexp' => [ - 'title' => '正则表达式', - 'description' => '正则表达式。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '^\\d+$', - 'backendName' => 'regex', + 'Regexp' => ['title' => '正则表达式', 'description' => '正则表达式。', 'visibility' => 'Public', 'type' => 'string', 'example' => '^\\d+$', 'backendName' => 'regex'], + ], + ], + 'WafRatelimitCharacteristics' => [ + 'description' => 'The characteristics of a WAF rate limit rule.', + 'type' => 'object', + 'properties' => [ + 'Logic' => ['description' => 'The logical relationship between the criteria.', 'type' => 'string', 'title' => '', 'example' => 'and'], + 'Criteria' => [ + 'description' => 'A list of match criteria.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Logic' => ['description' => 'The logical relationship between the criteria.', 'type' => 'string', 'title' => '', 'example' => 'and'], + 'Criteria' => [ + 'description' => 'A list of match criteria.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Logic' => ['description' => 'The logical relationship between the criteria.', 'type' => 'string', 'title' => '', 'example' => 'and'], + 'Criteria' => [ + 'description' => 'A list of match criteria.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MatchType' => ['description' => 'The field to match.', 'type' => 'string', 'title' => '', 'example' => 'ip.src'], + ], + 'description' => 'A match criterion.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'MatchType' => ['description' => 'The field to match.', 'type' => 'string', 'title' => '', 'example' => 'ip.src'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'MatchType' => ['description' => 'The field to match.', 'type' => 'string', 'title' => '', 'example' => 'ip.src'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'MatchType' => ['description' => 'The field to match.', 'type' => 'string', 'title' => '', 'example' => 'ip.src'], ], + 'title' => '', + 'example' => '', ], 'WafRuleConfig' => [ 'title' => 'A short description of struct', @@ -954,22 +587,8 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '规则状态', - 'description' => 'The status of the WAF rule.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'on', - 'backendName' => 'status', - ], - 'Action' => [ - 'title' => '执行动作', - 'description' => 'The operation to perform after the WAF rule is matched.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'deny', - 'backendName' => 'action', - ], + 'Status' => ['title' => '规则状态', 'description' => 'The status of the WAF rule.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'on', 'backendName' => 'status'], + 'Action' => ['title' => '执行动作', 'description' => 'The operation to perform after the WAF rule is matched.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'deny', 'backendName' => 'action'], 'Actions' => [ 'title' => '扩展动作', 'description' => 'The extended action configurations.'."\n", @@ -982,24 +601,8 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '自定义响应页面ID', - 'description' => 'The ID of the custom error page, which can be obtained by calling the [ListPages](~~2850223~~) operation.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50000001', - 'backendName' => 'id', - ], - 'Code' => [ - 'title' => '自定义响应码', - 'description' => 'The custom response code.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '403', - 'backendName' => 'code', - ], + 'Id' => ['title' => '自定义响应页面ID', 'description' => 'The ID of the custom error page, which can be obtained by calling the [ListPages](~~2850223~~) operation.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '50000001', 'backendName' => 'id'], + 'Code' => ['title' => '自定义响应码', 'description' => 'The custom response code.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '403', 'backendName' => 'code'], ], 'backendName' => 'response', ], @@ -1009,27 +612,13 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Skip' => [ - 'title' => '跳过模块类型', - 'description' => 'The skip scope applied when requests match conditions defined in the whitelist rule.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'part', - 'backendName' => 'skip', - ], + 'Skip' => ['title' => '跳过模块类型', 'description' => 'The skip scope applied when requests match conditions defined in the whitelist rule.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'part', 'backendName' => 'skip'], 'RegularRules' => [ 'title' => '托管规则id列表', 'description' => 'The IDs of managed rules.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the managed rule.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100001', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The ID of the managed rule.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '100001', 'extendType' => 'true'], 'backendName' => 'regularRules', ], 'CustomRules' => [ @@ -1037,14 +626,7 @@ 'description' => 'The IDs of custom rules.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the custom rule.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20000001', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The ID of the custom rule.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '20000001', 'extendType' => 'true'], 'backendName' => 'customRules', ], 'RegularTypes' => [ @@ -1052,13 +634,7 @@ 'description' => 'The types of managed rules.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The type of the managed rule.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sqli', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The type of the managed rule.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'sqli', 'extendType' => 'true'], 'backendName' => 'regularTypes', ], 'Tags' => [ @@ -1066,13 +642,7 @@ 'description' => 'The skipped rule categories when requests match conditions defined in the whitelist rule.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The skipped rule category when requests match conditions defined in the whitelist rule.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'http_custom', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The skipped rule category when requests match conditions defined in the whitelist rule.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'http_custom', 'extendType' => 'true'], 'backendName' => 'tags', ], ], @@ -1081,14 +651,7 @@ ], 'backendName' => 'actions', ], - 'ManagedList' => [ - 'title' => '名单名字', - 'description' => 'The managed list.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'intelligence_crawler', - 'backendName' => 'managedList', - ], + 'ManagedList' => ['title' => '名单名字', 'description' => 'The managed list.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'intelligence_crawler', 'backendName' => 'managedList'], 'ManagedRulesets' => [ 'title' => '托管规则集列表', 'description' => 'The managed rulesets.'."\n", @@ -1099,23 +662,8 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'ProtectionLevel' => [ - 'title' => '防护等级', - 'description' => 'The protection level.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - 'backendName' => 'protectionLevel', - ], - 'Action' => [ - 'title' => '执行动作', - 'description' => 'The action.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'deny', - 'backendName' => 'action', - ], + 'ProtectionLevel' => ['title' => '防护等级', 'description' => 'The protection level.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'backendName' => 'protectionLevel'], + 'Action' => ['title' => '执行动作', 'description' => 'The action.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'deny', 'backendName' => 'action'], 'ManagedRules' => [ 'title' => '托管规则列表', 'description' => 'The managed rules.'."\n", @@ -1126,63 +674,17 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '托管规则状态', - 'description' => 'The status of the managed rule.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'on', - 'backendName' => 'status', - ], - 'Action' => [ - 'title' => '托管规则动作', - 'description' => 'The action performed on requests that match the managed rule.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'deny', - 'backendName' => 'action', - ], - 'Id' => [ - 'title' => '托管规则ID', - 'description' => 'The ID of the managed rule.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100001', - 'backendName' => 'id', - ], + 'Status' => ['title' => '托管规则状态', 'description' => 'The status of the managed rule.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'on', 'backendName' => 'status'], + 'Action' => ['title' => '托管规则动作', 'description' => 'The action performed on requests that match the managed rule.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'deny', 'backendName' => 'action'], + 'Id' => ['title' => '托管规则ID', 'description' => 'The ID of the managed rule.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '100001', 'backendName' => 'id'], ], 'extendType' => 'true', ], 'backendName' => 'managedRules', ], - 'AttackType' => [ - 'title' => '攻击类型', - 'description' => 'The attack type.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - 'backendName' => 'attackType', - ], - 'NumberTotal' => [ - 'title' => '规则总数', - 'description' => 'The total number of rules.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - 'backendName' => 'numberTotal', - ], - 'NumberEnabled' => [ - 'title' => '已开启规则数', - 'description' => 'The number of enabled rules.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - 'backendName' => 'numberEnabled', - ], + 'AttackType' => ['title' => '攻击类型', 'description' => 'The attack type.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'backendName' => 'attackType'], + 'NumberTotal' => ['title' => '规则总数', 'description' => 'The total number of rules.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'backendName' => 'numberTotal'], + 'NumberEnabled' => ['title' => '已开启规则数', 'description' => 'The number of enabled rules.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'backendName' => 'numberEnabled'], ], 'extendType' => 'true', ], @@ -1193,23 +695,10 @@ 'description' => 'The token verification configurations.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The token verification configuration item.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sig', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The token verification configuration item.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'sig', 'extendType' => 'true'], 'backendName' => 'sigchl', ], - 'Name' => [ - 'title' => '规则名称', - 'description' => 'The name of the WAF rule.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'example', - 'backendName' => 'name', - ], + 'Name' => ['title' => '规则名称', 'description' => 'The name of the WAF rule.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'example', 'backendName' => 'name'], 'AppSdk' => [ 'title' => 'app sdk', 'description' => 'The SDK configuration for apps.'."\n", @@ -1222,45 +711,18 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Value' => [ - 'title' => '字段值', - 'description' => 'The field value.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'examplesignvalue', - 'backendName' => 'value', - ], - 'Key' => [ - 'title' => '字段名', - 'description' => 'The field name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sign', - 'backendName' => 'key', - ], + 'Value' => ['title' => '字段值', 'description' => 'The field value.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'examplesignvalue', 'backendName' => 'value'], + 'Key' => ['title' => '字段名', 'description' => 'The field name.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'sign', 'backendName' => 'key'], ], 'backendName' => 'customSign', ], - 'CustomSignStatus' => [ - 'title' => '自定义加签字段开关', - 'description' => 'Indicates whether to configure the custom signature field.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'on', - 'backendName' => 'customSignStatus', - ], + 'CustomSignStatus' => ['title' => '自定义加签字段开关', 'description' => 'Indicates whether to configure the custom signature field.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'on', 'backendName' => 'customSignStatus'], 'FeatureAbnormal' => [ 'title' => '特征异常', 'description' => 'The app anomalies.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The app anomaly.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'wxbb_invalid_sign', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The app anomaly.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'wxbb_invalid_sign', 'extendType' => 'true'], 'backendName' => 'featureAbnormal', ], ], @@ -1272,131 +734,39 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Characteristics' => [ - 'title' => '统计对象', - 'description' => 'The statistical objects to which the rule applies.'."\n", - 'visibility' => 'Public', - 'backendName' => 'characteristics', - '$ref' => '#/components/schemas/WafRuleMatch2', - ], - 'OnHit' => [ - 'title' => '在命中缓存的请求上应用', - 'description' => 'Indicates whether to apply the rule to requests that hit the cache.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'onHit', - ], - 'TTL' => [ - 'title' => '超时时间', - 'description' => 'The timeout period for creating the stack.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'backendName' => 'ttl', - ], + 'Characteristics' => ['title' => '统计对象', 'description' => 'The statistical objects to which the rule applies.'."\n", 'visibility' => 'Public', 'backendName' => 'characteristics', '$ref' => '#/components/schemas/WafRuleMatch2'], + 'OnHit' => ['title' => '在命中缓存的请求上应用', 'description' => 'Indicates whether to apply the rule to requests that hit the cache.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'onHit'], + 'TTL' => ['title' => '超时时间', 'description' => 'The timeout period for creating the stack.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'backendName' => 'ttl'], 'Threshold' => [ 'title' => '阈值', 'description' => 'The thresholds.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'ManagedRulesBlocked' => [ - 'title' => '托管规则命中阈值', - 'description' => 'The maximum number of times that the managed rule is triggered.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'backendName' => 'managedRulesBlocked', - ], - 'DistinctManagedRules' => [ - 'title' => '不同的托管规则个数阈值', - 'description' => 'The maximum number of managed rules that are triggered.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'backendName' => 'distinctManagedRules', - ], + 'ManagedRulesBlocked' => ['title' => '托管规则命中阈值', 'description' => 'The maximum number of times that the managed rule is triggered.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'backendName' => 'managedRulesBlocked'], + 'DistinctManagedRules' => ['title' => '不同的托管规则个数阈值', 'description' => 'The maximum number of managed rules that are triggered.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'backendName' => 'distinctManagedRules'], 'ResponseStatus' => [ 'title' => '响应码阈值', 'description' => 'The configuration of the status code threshold.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Ratio' => [ - 'title' => '响应码百分比', - 'description' => 'The percentage of the occurrences of the status code to total status codes.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'backendName' => 'ratio', - ], - 'Count' => [ - 'title' => '响应码次数阈值', - 'description' => 'The maximum number of times that the status code is returned.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'backendName' => 'count', - ], - 'Code' => [ - 'title' => 'HTTP响应码', - 'description' => 'The HTTP status code.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '404', - 'backendName' => 'code', - ], + 'Ratio' => ['title' => '响应码百分比', 'description' => 'The percentage of the occurrences of the status code to total status codes.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'backendName' => 'ratio'], + 'Count' => ['title' => '响应码次数阈值', 'description' => 'The maximum number of times that the status code is returned.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'backendName' => 'count'], + 'Code' => ['title' => 'HTTP响应码', 'description' => 'The HTTP status code.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '404', 'backendName' => 'code'], ], 'backendName' => 'responseStatus', ], - 'Traffic' => [ - 'title' => '流量阈值', - 'description' => 'The traffic threshold, which is deprecated.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '10Gb', - 'backendName' => 'traffic', - ], - 'Request' => [ - 'title' => '请求阈值', - 'description' => 'The request threshold.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'backendName' => 'request', - 'parseType' => 'struct', - ], + 'Traffic' => ['title' => '流量阈值', 'description' => 'The traffic threshold, which is deprecated.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '10Gb', 'backendName' => 'traffic'], + 'Request' => ['title' => '请求阈值', 'description' => 'The request threshold.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'backendName' => 'request', 'parseType' => 'struct'], ], 'backendName' => 'threshold', ], - 'Interval' => [ - 'title' => '统计时长', - 'description' => 'The statistical interval.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'backendName' => 'interval', - ], + 'Interval' => ['title' => '统计时长', 'description' => 'The statistical interval.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'backendName' => 'interval'], ], 'backendName' => 'rateLimit', ], - 'Type' => [ - 'title' => '规则类型', - 'description' => 'The name of the WAF rule.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'http_custom', - 'backendName' => 'type', - ], + 'Type' => ['title' => '规则类型', 'description' => 'The name of the WAF rule.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'http_custom', 'backendName' => 'type'], 'AppPackage' => [ 'title' => '二次打包检测', 'description' => 'The configuration of secondary package detection.'."\n", @@ -1413,22 +783,8 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Sign' => [ - 'title' => '包签名', - 'description' => 'The valid package signature.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sign', - 'backendName' => 'sign', - ], - 'Name' => [ - 'title' => '指定合法包名', - 'description' => 'The valid package name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'name', - 'backendName' => 'name', - ], + 'Sign' => ['title' => '包签名', 'description' => 'The valid package signature.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'sign', 'backendName' => 'sign'], + 'Name' => ['title' => '指定合法包名', 'description' => 'The valid package name.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'name', 'backendName' => 'name'], ], 'extendType' => 'true', ], @@ -1437,79 +793,29 @@ ], 'backendName' => 'appPackage', ], - 'ManagedGroupId' => [ - 'title' => '托管规则组id', - 'description' => 'The ID of the managed rule group, which is deprecated.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30000001', - 'backendName' => 'managedGroupId', - ], - 'Timer' => [ - 'title' => '定时器', - 'description' => 'The timer.'."\n", - 'visibility' => 'Public', - 'backendName' => 'timer', - '$ref' => '#/components/schemas/WafTimer', - ], - 'Expression' => [ - 'title' => '表达式', - 'description' => 'The match expression.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ip.src eq 1.1.1.1', - 'backendName' => 'expression', - ], + 'ManagedGroupId' => ['title' => '托管规则组id', 'description' => 'The ID of the managed rule group, which is deprecated.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '30000001', 'backendName' => 'managedGroupId'], + 'Timer' => ['title' => '定时器', 'description' => 'The timer.'."\n", 'visibility' => 'Public', 'backendName' => 'timer', '$ref' => '#/components/schemas/WafTimer'], + 'Expression' => ['title' => '表达式', 'description' => 'The match expression.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'ip.src eq 1.1.1.1', 'backendName' => 'expression'], 'SecurityLevel' => [ 'title' => '安全级别', 'description' => 'The security level.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Value' => [ - 'title' => '安全级别的值', - 'description' => 'Valid value:'."\n" - ."\n" - .'* off'."\n" - .'* essentially_off'."\n" - .'* low'."\n" - .'* medium'."\n" - .'* high'."\n" - .'* under_attack'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'low', - 'backendName' => 'value', - ], + 'Value' => ['title' => '安全级别的值', 'description' => 'Valid value:'."\n" + ."\n" + .'* off'."\n" + .'* essentially_off'."\n" + .'* low'."\n" + .'* medium'."\n" + .'* high'."\n" + .'* under_attack'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'low', 'backendName' => 'value'], ], 'backendName' => 'securityLevel', ], - 'Value' => [ - 'title' => 'IP访问控制值', - 'description' => 'Defines whether the IP can access.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '10.0.0.1', - 'backendName' => 'value', - ], - 'Id' => [ - 'title' => '规则id', - 'description' => 'The ID of the WAF rule.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20000001', - 'backendName' => 'id', - ], - 'Notes' => [ - 'title' => '备注', - 'description' => 'The remarks.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'example notes', - 'backendName' => 'notes', - ], + 'Value' => ['title' => 'IP访问控制值', 'description' => 'Defines whether the IP can access.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '10.0.0.1', 'backendName' => 'value'], + 'Id' => ['title' => '规则id', 'description' => 'The ID of the WAF rule.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '20000001', 'backendName' => 'id'], + 'Notes' => ['title' => '备注', 'description' => 'The remarks.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'example notes', 'backendName' => 'notes'], ], ], 'WafRuleMatch' => [ @@ -1517,65 +823,20 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Logic' => [ - 'title' => '逻辑关系', - 'description' => '逻辑关系。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'and', - 'backendName' => 'logic', - ], + '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', - ], + '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', - ], + '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' => [ @@ -1583,14 +844,7 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Logic' => [ - 'title' => '逻辑关系', - 'description' => 'The logical judgment.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'and', - 'backendName' => 'logic', - ], + 'Logic' => ['title' => '逻辑关系', 'description' => 'The logical judgment.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'and', 'backendName' => 'logic'], 'Criteria' => [ 'title' => '逻辑列表', 'description' => 'The details of logical databases.'."\n", @@ -1600,14 +854,7 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Logic' => [ - 'title' => '逻辑关系', - 'description' => 'The logical judgment.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'and', - 'backendName' => 'logic', - ], + 'Logic' => ['title' => '逻辑关系', 'description' => 'The logical judgment.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'and', 'backendName' => 'logic'], 'Criteria' => [ 'title' => '逻辑列表', 'description' => 'The details of logical databases.'."\n", @@ -1617,14 +864,7 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Logic' => [ - 'title' => '逻辑关系', - 'description' => 'The logical judgment.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'and', - 'backendName' => 'logic', - ], + 'Logic' => ['title' => '逻辑关系', 'description' => 'The logical judgment.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'and', 'backendName' => 'logic'], 'Criteria' => [ 'title' => '逻辑列表', 'description' => 'The details of logical databases.'."\n", @@ -1634,370 +874,156 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'MatchType' => [ - 'title' => '匹配域', - 'description' => 'The matching type.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ip.src', - 'backendName' => 'type', - ], - 'MatchOperator' => [ - 'title' => '匹配符', - 'description' => 'The matching operator.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'eq', - 'backendName' => 'operator', - ], - 'MatchValue' => [ - 'title' => '匹配值', - 'description' => 'The value of the matching condition.'."\n", - 'visibility' => 'Public', - 'type' => 'any', - 'example' => '1.1.1.1', - 'backendName' => 'value', - ], - 'Negate' => [ - 'title' => '匹配结果取反', - 'description' => 'Converts a value or condition to its opposite.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'backendName' => 'negate', - ], - 'ConvertToLower' => [ - 'title' => '值大小写不敏感', - 'description' => 'Transforms input to lowercase to ensure case-insensitivity.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'backendName' => 'convertToLower', - ], + 'MatchType' => ['title' => '匹配域', 'description' => 'The matching type.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'ip.src', 'backendName' => 'type'], + 'MatchOperator' => ['title' => '匹配符', 'description' => 'The matching operator.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'eq', 'backendName' => 'operator'], + 'MatchValue' => ['title' => '匹配值', 'description' => 'The value of the matching condition.'."\n", 'visibility' => 'Public', 'type' => 'any', 'example' => '1.1.1.1', 'backendName' => 'value'], + 'Negate' => ['title' => '匹配结果取反', 'description' => 'Converts a value or condition to its opposite.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'negate'], + 'ConvertToLower' => ['title' => '值大小写不敏感', 'description' => 'Transforms input to lowercase to ensure case-insensitivity.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'convertToLower'], ], 'extendType' => 'true', 'description' => '', ], 'backendName' => 'criteria', ], - 'MatchType' => [ - 'title' => '匹配域', - 'description' => 'The matching type.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ip.src', - 'backendName' => 'type', - ], - 'MatchOperator' => [ - 'title' => '匹配符', - 'description' => 'The matching operator.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'eq', - 'backendName' => 'operator', - ], - 'MatchValue' => [ - 'title' => '匹配值', - 'description' => 'The value of the matching condition.'."\n", - 'visibility' => 'Public', - 'type' => 'any', - 'example' => '1.1.1.1', - 'backendName' => 'value', - ], - 'Negate' => [ - 'title' => '匹配结果取反', - 'description' => 'Converts a value or condition to its opposite.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'backendName' => 'negate', - ], - 'ConvertToLower' => [ - 'title' => '值大小写不敏感', - 'description' => 'Transforms input to lowercase to ensure case-insensitivity.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'backendName' => 'convertToLower', - ], + 'MatchType' => ['title' => '匹配域', 'description' => 'The matching type.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'ip.src', 'backendName' => 'type'], + 'MatchOperator' => ['title' => '匹配符', 'description' => 'The matching operator.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'eq', 'backendName' => 'operator'], + 'MatchValue' => ['title' => '匹配值', 'description' => 'The value of the matching condition.'."\n", 'visibility' => 'Public', 'type' => 'any', 'example' => '1.1.1.1', 'backendName' => 'value'], + 'Negate' => ['title' => '匹配结果取反', 'description' => 'Converts a value or condition to its opposite.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'negate'], + 'ConvertToLower' => ['title' => '值大小写不敏感', 'description' => 'Transforms input to lowercase to ensure case-insensitivity.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'convertToLower'], ], 'extendType' => 'true', 'description' => '', ], 'backendName' => 'criteria', ], - 'MatchType' => [ - 'title' => '匹配域', - 'description' => 'The matching type.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ip.src', - 'backendName' => 'type', - ], - 'MatchOperator' => [ - 'title' => '匹配符', - 'description' => 'The matching operator.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'eq', - 'backendName' => 'operator', - ], - 'MatchValue' => [ - 'title' => '匹配值', - 'description' => 'The value of the matching condition.'."\n", - 'visibility' => 'Public', - 'type' => 'any', - 'example' => '1.1.1.1', - 'backendName' => 'value', - ], - 'Negate' => [ - 'title' => '匹配结果取反', - 'description' => 'Converts a value or condition to its opposite.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'backendName' => 'negate', - ], - 'ConvertToLower' => [ - 'title' => '值大小写不敏感', - 'description' => 'Transforms input to lowercase to ensure case-insensitivity.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'backendName' => 'convertToLower', - ], + 'MatchType' => ['title' => '匹配域', 'description' => 'The matching type.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'ip.src', 'backendName' => 'type'], + 'MatchOperator' => ['title' => '匹配符', 'description' => 'The matching operator.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'eq', 'backendName' => 'operator'], + 'MatchValue' => ['title' => '匹配值', 'description' => 'The value of the matching condition.'."\n", 'visibility' => 'Public', 'type' => 'any', 'example' => '1.1.1.1', 'backendName' => 'value'], + 'Negate' => ['title' => '匹配结果取反', 'description' => 'Converts a value or condition to its opposite.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'negate'], + 'ConvertToLower' => ['title' => '值大小写不敏感', 'description' => 'Transforms input to lowercase to ensure case-insensitivity.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'convertToLower'], ], 'extendType' => 'true', 'description' => '', ], 'backendName' => 'criteria', ], - 'MatchType' => [ - 'title' => '匹配域', - 'description' => 'The matching type.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ip.src', - 'backendName' => 'type', - ], - 'MatchOperator' => [ - 'title' => '匹配符', - 'description' => 'The matching operator.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'eq', - 'backendName' => 'operator', - ], - 'MatchValue' => [ - 'title' => '匹配值', - 'description' => 'The value of the matching condition.'."\n", - 'visibility' => 'Public', - 'type' => 'any', - 'example' => '1.1.1.1', - 'backendName' => 'value', - ], - 'Negate' => [ - 'title' => '匹配结果取反', - 'description' => 'Converts a value or condition to its opposite.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'backendName' => 'negate', - ], - 'ConvertToLower' => [ - 'title' => '值大小写不敏感', - 'description' => 'Transforms input to lowercase to ensure case-insensitivity.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'backendName' => 'convertToLower', - ], + 'MatchType' => ['title' => '匹配域', 'description' => 'The matching type.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'ip.src', 'backendName' => 'type'], + 'MatchOperator' => ['title' => '匹配符', 'description' => 'The matching operator.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'eq', 'backendName' => 'operator'], + 'MatchValue' => ['title' => '匹配值', 'description' => 'The value of the matching condition.'."\n", 'visibility' => 'Public', 'type' => 'any', 'example' => '1.1.1.1', 'backendName' => 'value'], + 'Negate' => ['title' => '匹配结果取反', 'description' => 'Converts a value or condition to its opposite.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'negate'], + 'ConvertToLower' => ['title' => '值大小写不敏感', 'description' => 'Transforms input to lowercase to ensure case-insensitivity.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'convertToLower'], ], ], 'WafSiteSettings' => [ - 'title' => 'A short description of struct', - 'description' => 'A short description of struct'."\n", + 'title' => '', + 'description' => 'A short description of struct', 'type' => 'object', 'properties' => [ 'ClientIpIdentifier' => [ - 'title' => '客户端IP识别', - 'description' => 'Identifies the IP address of the client.'."\n", + 'title' => '', + 'description' => 'The client IP identification.', 'type' => 'object', 'properties' => [ - 'Headers' => [ - 'title' => '指定header', - 'description' => 'Specify headers.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Specifies the header.'."\n", - 'type' => 'string', - 'example' => 'X-Forwarded-For', - 'title' => '', - ], - 'example' => '', - ], 'Mode' => [ - 'title' => '识别模式', - 'description' => 'Identifies the mode.'."\n" - ."\n" - .'Enumerated values:'."\n" - ."\n" - .'* headers: specifies the headers.'."\n" - .'* connection_ip: the IP address for establishing a connection.'."\n", + 'title' => '', + 'description' => 'The identification mode.', + 'enumValueTitles' => ['headers' => 'Specified headers.', 'connection_ip' => 'Connection IP.'], 'type' => 'string', - 'enumValueTitles' => [ - 'headers' => '指定headers', - 'connection_ip' => '建连IP', - ], 'example' => 'headers', ], + 'Headers' => [ + 'title' => '', + 'description' => 'The specified headers.', + 'type' => 'array', + 'items' => ['description' => 'The specified header.', 'type' => 'string', 'example' => 'X-Forwarded-For', 'title' => ''], + 'example' => '', + ], ], 'example' => '', ], 'AddBotProtectionHeaders' => [ - 'title' => '添加BOT保护标头', - 'description' => 'Adds a bot protection header.'."\n", + 'title' => '', + 'description' => 'The bot protection headers.', 'type' => 'object', 'properties' => [ - 'Enable' => [ - 'title' => '开关', - 'description' => 'Indicates whether the parameter is enabled.'."\n", - 'type' => 'boolean', - 'example' => '', - ], + 'Enable' => ['title' => '', 'description' => 'The switch.', 'type' => 'boolean', 'example' => ''], ], 'example' => '', ], 'AddSecurityHeaders' => [ - 'title' => '添加安全标头', - 'description' => 'Adds security request header.'."\n", + 'title' => '', + 'description' => 'The security headers.', 'type' => 'object', 'properties' => [ - 'Enable' => [ - 'title' => '开关', - 'description' => 'Indicates whether the parameter is enabled.'."\n", - 'type' => 'boolean', - 'example' => '', - ], + 'Enable' => ['title' => '', 'description' => 'The switch.', 'type' => 'boolean', 'example' => ''], ], 'example' => '', ], 'SecurityLevel' => [ - 'title' => '安全级别', - 'description' => 'The security level.'."\n", + 'title' => '', + 'description' => 'The security level.', 'type' => 'object', 'properties' => [ 'Value' => [ - 'title' => '安全级别值', - 'description' => 'The security level value.'."\n" - ."\n" - .'Enumerated values:'."\n" - ."\n" - .'* high: high.'."\n" - .'* low: low.'."\n" - .'* under_attack: I am under attack.'."\n" - .'* medium: medium.'."\n" - .'* essentially_off: essentially off.'."\n" - .'* off: completely off.'."\n", + 'title' => '', + 'description' => 'The security level value.', + 'enumValueTitles' => ['high' => 'High.', 'low' => 'Low.', 'under_attack' => 'I\'m under attack.', 'medium' => 'Medium.', 'essentially_off' => 'Essentially off.', 'off' => 'Off.'], 'type' => 'string', - 'enumValueTitles' => [ - 'high' => '高', - 'low' => '低', - 'under_attack' => '我正在遭受攻击', - 'medium' => '中等', - 'essentially_off' => '基本关闭', - 'off' => '彻底关闭', - ], 'example' => 'low', ], ], 'example' => '', ], 'BotManagement' => [ - 'title' => 'Bot管理', - 'description' => 'Bot management.'."\n", + 'title' => '', + 'description' => 'The bot management.', 'type' => 'object', 'properties' => [ 'DefiniteBots' => [ - 'title' => '绝对是Bot', - 'description' => 'Definite Bots'."\n", + 'title' => '', + 'description' => 'The definite bots.', 'type' => 'object', 'properties' => [ - 'Action' => [ - 'title' => '动作', - 'description' => 'The action that you want to perform on requests that match the rule.'."\n", - 'type' => 'string', - 'example' => 'captcha', - ], - 'Id' => [ - 'title' => '规则ID', - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20000001', - ], + 'Id' => ['title' => '', 'description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '20000001'], + 'Action' => ['title' => '', 'description' => 'The action.', 'type' => 'string', 'example' => 'captcha'], ], 'example' => '', ], 'LikelyBots' => [ - 'title' => '可能是Bot', - 'description' => 'Likely Bots'."\n", + 'title' => '', + 'description' => 'The likely bots.', 'type' => 'object', 'properties' => [ - 'Action' => [ - 'title' => '动作', - 'description' => 'The action that you want to perform on requests that match the rule.'."\n", - 'type' => 'string', - 'example' => 'deny', - ], - 'Id' => [ - 'title' => '规则ID', - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20000002', - ], + 'Id' => ['title' => '', 'description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '20000002'], + 'Action' => ['title' => '', 'description' => 'The action.', 'type' => 'string', 'example' => 'deny'], ], 'example' => '', ], - 'JSDetection' => [ - 'title' => 'JavaScript探测', - 'description' => 'JavaScript detection.'."\n", + 'VerifiedBots' => [ + 'title' => '', + 'description' => 'The verified bots.', 'type' => 'object', 'properties' => [ - 'Enable' => [ - 'title' => '开关', - 'description' => 'Indicates whether the parameter is enabled.'."\n", - 'type' => 'boolean', - 'example' => '', - ], + 'Id' => ['title' => '', 'description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '20000003'], + 'Action' => ['title' => '', 'description' => 'The action.', 'type' => 'string', 'example' => 'bypass'], ], 'example' => '', ], - 'VerifiedBots' => [ - 'title' => '已通过验证的Bot', - 'description' => 'Verified Bots'."\n", + 'JSDetection' => [ + 'title' => '', + 'description' => 'The JavaScript detection.', 'type' => 'object', 'properties' => [ - 'Action' => [ - 'title' => '动作', - 'description' => 'The action that you want to perform on requests that match the rule.'."\n", - 'type' => 'string', - 'example' => 'bypass', - ], - 'Id' => [ - 'title' => '规则ID', - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20000003', - ], + 'Enable' => ['title' => '', 'description' => 'The switch.', 'type' => 'boolean', 'example' => ''], ], 'example' => '', ], 'EffectOnStatic' => [ - 'title' => '对静态资源请求生效', - 'description' => 'Takes effect on static resource requests.'."\n", + 'title' => '', + 'description' => 'Specifies whether the rule applies to static resource requests.', 'type' => 'object', 'properties' => [ - 'Enable' => [ - 'title' => '开关', - 'description' => 'Indicates whether the parameter is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Enable' => ['title' => '', 'description' => 'The switch.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], @@ -2005,43 +1031,48 @@ 'example' => '', ], 'BandwidthAbuseProtection' => [ - 'title' => '防盗刷。', - 'description' => '防盗刷。', + 'title' => '', + 'description' => 'The bandwidth abuse protection.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '防盗刷规则的开关状态。', - 'description' => '防盗刷规则的开关状态。', - 'type' => 'string', - 'example' => 'on', - ], - 'Action' => [ - 'title' => '防盗刷规则的执行动作。', - 'description' => '防盗刷规则的执行动作。', - 'type' => 'string', - 'example' => 'deny', - ], - 'Id' => [ - 'title' => '防盗刷规则的ID。', - 'description' => '防盗刷规则的ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000001', - ], + 'Id' => ['title' => '', 'description' => 'The ID of the bandwidth abuse protection rule.', 'type' => 'integer', 'example' => '10000001', 'format' => 'int64'], + 'Status' => ['title' => '', 'description' => 'The status of the bandwidth abuse protection rule.', 'type' => 'string', 'example' => 'on'], + 'Action' => ['title' => '', 'description' => 'The action of the bandwidth abuse protection rule.', 'type' => 'string', 'example' => 'deny'], ], 'example' => '', ], 'DisableSecurityModule' => [ - 'title' => '禁用安全模块', - 'description' => '禁用安全模块', + 'title' => '', + 'description' => 'The configuration for disabling the security module.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '禁用安全模块的状态开关', - 'description' => '禁用安全模块的状态开关', - 'type' => 'string', - 'example' => 'on', - ], + 'Status' => ['title' => '', 'description' => 'The status switch for disabling the security module.', 'type' => 'string', 'example' => 'on'], + ], + 'example' => '', + ], + 'RequestBodyInspection' => [ + 'title' => '', + 'description' => 'The request body inspection configuration. Controls the deep packet inspection behavior of WAF for HTTP request bodies. After this feature is enabled, content-based matching rules such as SQL injection and XSS detection take effect on request bodies.'."\n" + ."\n" + .'This structure can contain the following fields:'."\n" + .'- Id: The unique identifier of the built-in inspection rule.'."\n" + .'- SizeLimit: The maximum size of the request body to inspect.'."\n" + .'- Action: The action to take when the request body exceeds the size limit.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The request body inspection rule ID, which is the unique identifier of the built-in rule. When request body inspection is enabled, the server uses this ID to associate the matching logic of the built-in inspection rule. The valid values are based on the built-in rule list of WAF.', 'type' => 'integer', 'example' => '10000001', 'format' => 'int64'], + 'SizeLimit' => ['title' => '', 'description' => 'The maximum size of the request body to inspect, in bytes.'."\n" + ."\n" + .'- If the request body is less than or equal to this value, the entire content is subject to WAF matching.'."\n" + .'- If the request body exceeds this value, the action specified in the Action field is taken, such as inspecting only the first N bytes, rejecting the request, or allowing the request.'."\n" + ."\n" + .'> The valid value range and default value are determined by the WAF server-side configuration.', 'type' => 'string', 'example' => '16KB'], + 'Action' => ['title' => '', 'description' => 'The action to take when the request body size exceeds SizeLimit.'."\n" + ."\n" + .'Common valid values (the complete list is determined by the server-side configuration):'."\n" + .'- allow: allows the request without performing deep packet inspection on the portion that exceeds the limit.'."\n" + ."\n" + .'> The complete enumeration is determined by the WAF server-side configuration.', 'type' => 'string', 'example' => 'allow'], ], 'example' => '', ], @@ -2054,23 +1085,8 @@ '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', - ], + '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' => '生效时间段。', @@ -2080,22 +1096,8 @@ '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', - ], + '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', ], @@ -2110,14 +1112,7 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Days' => [ - 'title' => '周期，多个使用逗号分隔，1-7分别代表周一-周日。
例：周一，周三值为"1,3"', - 'description' => '周期，多个使用逗号分隔，1-7分别代表周一-周日。
例：周一，周三值为"1,3"。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1', - 'backendName' => 'days', - ], + 'Days' => ['title' => '周期，多个使用逗号分隔，1-7分别代表周一-周日。
例：周一，周三值为"1,3"', 'description' => '周期，多个使用逗号分隔，1-7分别代表周一-周日。
例：周一，周三值为"1,3"。', 'visibility' => 'Public', 'type' => 'string', 'example' => '1', 'backendName' => 'days'], 'DailyPeriods' => [ 'title' => '该周期内的生效时间', 'description' => '该周期内的生效时间。', @@ -2127,22 +1122,8 @@ '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', - ], + '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', ], @@ -2160,12 +1141,8 @@ 'apis' => [ 'ActivateClientCertificate' => [ 'summary' => 'Activates the client based on the certificate ID.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2178,33 +1155,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238804', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The certificate ID, which can be obtained by calling the [ListClientCertificates](~~2852848~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'babaded901474b9693acf530e0fb****', - 'title' => '', - ], + 'schema' => ['description' => 'The certificate ID, which can be obtained by calling the [ListClientCertificates](~~2852848~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'babaded901474b9693acf530e0fb****', 'title' => ''], ], ], 'responses' => [ @@ -2214,31 +1176,10 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567890123', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com ', - 'title' => '', - ], - 'Id' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'example' => 'babaded901474b9693acf530e0fb****', - 'title' => '', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - 'title' => '', - ], + 'SiteId' => ['description' => 'The website ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''], + 'SiteName' => ['description' => 'The website name.'."\n", 'type' => 'string', 'example' => 'example.com ', 'title' => ''], + 'Id' => ['description' => 'The certificate ID.'."\n", 'type' => 'string', 'example' => 'babaded901474b9693acf530e0fb****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', 'title' => ''], ], 'example' => '', ], @@ -2246,66 +1187,28 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Certificate.StatusError', - 'errorMessage' => 'The status of the certificate is invalid.', - 'description' => 'The specified certificate status is invalid.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'Id.MissingParameter', - 'errorMessage' => 'The parameter Id is required.', - 'description' => 'The required parameter Id is missing.', - ], + ['errorCode' => 'Certificate.StatusError', 'errorMessage' => 'The status of the certificate is invalid.', 'description' => 'The specified certificate status is invalid.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Id.MissingParameter', 'errorMessage' => 'The parameter Id is required.', 'description' => 'The required parameter Id is missing.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'Certificate.NotFound', - 'errorMessage' => 'The specified certificate does not exist.', - 'description' => 'The specified certificate does not exist.', - ], + ['errorCode' => 'Certificate.NotFound', 'errorMessage' => 'The specified certificate does not exist.', 'description' => 'The specified certificate does not exist.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 1234567890123,\\n \\"SiteName\\": \\"example.com \\",\\n \\"Id\\": \\"babaded901474b9693acf530e0fb****\\",\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', 'title' => 'ActivateClientCertificate', 'changeSet' => [ - [ - 'createdAt' => '2024-09-23T02:15:35.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-23T02:15:35.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ActivateClientCertificate', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ActivateClientCertificate'], ], ], 'ramActions' => [ @@ -2316,12 +1219,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -2332,13 +1230,9 @@ ], ], 'ActivateVersionManagement' => [ - 'summary' => 'Enable Version Management', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Enables version management. This allows a site to support multiple configuration versions and multiple deployment environments, providing more flexible management of site traffic and configuration.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2351,22 +1245,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239166', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11223***', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11223***', 'title' => ''], ], ], 'responses' => [ @@ -2374,12 +1259,7 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D2***', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D2***', 'title' => ''], ], 'description' => '', 'title' => '', @@ -2389,77 +1269,31 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'The current plan\'s quota of version management is insufficient. Please try to upgrade the plan.', - 'description' => 'The version management quota of the current package is insufficient. Please try to upgrade the package version.', - ], - [ - 'errorCode' => 'Site.ServiceBusy', - 'errorMessage' => 'This website is being configured. Try again later.', - 'description' => 'This website is being configured. Try again later.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'The current plan\'s quota of version management is insufficient. Please try to upgrade the plan.', 'description' => 'The version management quota of the current package is insufficient. Please try to upgrade the package version.'], + ['errorCode' => 'Site.ServiceBusy', 'errorMessage' => 'This website is being configured. Try again later.', 'description' => 'This website is being configured. Try again later.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C370DAF1-C838-4288-A1A0-9A87633D2***\\"\\n}","type":"json"}]', - 'title' => 'ActivateVersionManagement', + 'title' => 'Enable site version management', + 'description' => 'Prerequisites for enabling site version management:'."\n" + ."\n" + .'1. The site plan must include the version management quota item `version_management_available`, and its value must be `true`.', '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}', - ], - ], - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ActivateVersionManagement'], ], ], + 'ramActions' => [], ], 'ApplyCertificate' => [ - 'summary' => 'Applies for a free SSL certificate.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Applies for a free certificate.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2472,46 +1306,27 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238947', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'Domains', 'in' => 'query', - 'schema' => [ - 'description' => 'List of domains, separated by commas.', - 'type' => 'string', - 'required' => true, - 'example' => 'www.example.com,blog.example.com', - 'title' => '', - ], + 'schema' => ['description' => 'A comma-separated list of domain names.', 'type' => 'string', 'required' => true, 'example' => 'www.example.com,blog.example.com', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => 'The certificate type. Valid values: lets_encrypt, digicert_single, and digicert_wildcard.'."\n", + 'description' => 'The certificate type. Valid values: `lets_encrypt` for a Let\'s Encrypt certificate, `digicert_single` for a Digicert single-domain certificate, and `digicert_wildcard` for a Digicert wildcard certificate.', + 'enumValueTitles' => ['digicert_wildcard' => 'digicert\\_wildcard', 'lets_encrypt' => 'lets\\_encrypt', 'digicert_single' => 'digicert\\_single'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'digicert_wildcard' => 'digicert_wildcard', - 'lets_encrypt' => 'lets_encrypt', - 'digicert_single' => 'digicert_single', - ], 'example' => 'lets_encrypt', 'title' => '', ], @@ -2521,47 +1336,21 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'SiteName' => [ - 'description' => 'Site name.', - 'type' => 'string', - 'example' => 'example.com ', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'Number of certificates applied for, which is the same as the number of input domains.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - 'title' => '', - ], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com ', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of certificates requested, which matches the number of domain names provided in the request.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'Result' => [ - 'description' => 'List of free certificate application details.', + 'description' => 'A list of application details for each free certificate.', 'type' => 'array', 'items' => [ - 'description' => 'Details of the free certificate application.', + 'description' => 'The details for a free certificate application.', 'type' => 'object', 'properties' => [ - 'Domain' => [ - 'description' => 'Certificate domain.', - 'type' => 'string', - 'example' => '*.example.com ', - 'title' => '', - ], - 'Status' => [ - 'description' => 'Status of the certificate application.', - 'type' => 'string', - 'example' => 'Applying', - 'title' => '', - ], - 'Id' => [ - 'description' => 'Certificate ID.', - 'type' => 'string', - 'example' => '30000478', - 'title' => '', - ], + 'Domain' => ['description' => 'The certificate domain name.', 'type' => 'string', 'example' => '*.example.com ', 'title' => ''], + 'Status' => ['description' => 'The certificate application status.', 'type' => 'string', 'example' => 'Applying', 'title' => ''], + 'Id' => ['description' => 'The certificate ID.', 'type' => 'string', 'example' => '30000478', 'title' => ''], ], 'title' => '', 'example' => '', @@ -2569,12 +1358,7 @@ 'title' => '', 'example' => '', ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792', 'title' => ''], ], 'example' => '', ], @@ -2582,78 +1366,27 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The specified site is not found.', - 'description' => 'The site you specified does not exist. Please check whether the site you entered is correct.', - ], - [ - 'errorCode' => 'SiteNotActivated', - 'errorMessage' => 'The site is not activated, the process is not allowed.', - 'description' => 'The operation is not supported because the site is not activated.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InvalidParameter.Domains', - 'errorMessage' => 'You have already submitted a certificate application for the domain name.', - 'description' => 'You have already submitted a certificate application for the domain name.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'QuotaCheckFailed', - 'errorMessage' => 'Failed to check free certificate Quota, please try again later.', - 'description' => 'Failed to check free certificate Quota, please try again later.', - ], - [ - 'errorCode' => 'InvalidParameter.Type', - 'errorMessage' => 'The specified Type parameter is invalid, please check and try again.', - 'description' => 'The Type parameter you configured is incorrect. Please check and try again. Certificate application type support 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' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The specified site is not found.', 'description' => 'The site you specified does not exist. Please check whether the site you entered is correct.'], + ['errorCode' => 'SiteNotActivated', 'errorMessage' => 'The site is not activated, the process is not allowed.', 'description' => 'The operation is not supported because the site is not activated.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InvalidParameter.Domains', 'errorMessage' => 'You have already submitted a certificate application for the domain name.', 'description' => 'You have already submitted a certificate application for the domain name.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'QuotaCheckFailed', 'errorMessage' => 'Failed to check free certificate Quota, please try again later.', 'description' => 'Failed to check free certificate Quota, please try again later.'], + ['errorCode' => 'InvalidParameter.Type', 'errorMessage' => 'The specified Type parameter is invalid, please check and try again.', 'description' => 'The Type parameter you configured is incorrect. Please check and try again. Certificate application type support 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' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], - [ - 'errorCode' => 'QuotaExceeded', - 'errorMessage' => 'The quota is exceeded.', - 'description' => 'The quota is exceeded.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], + ['errorCode' => 'QuotaExceeded', 'errorMessage' => 'The quota is exceeded.', 'description' => 'The quota is exceeded.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ApplyCertificate', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ApplyCertificate', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApplyCertificate'], ], ], 'ramActions' => [ @@ -2664,12 +1397,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -2677,13 +1405,8 @@ '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' => [ - 'summary' => 'Requests a new free certificate for a Software as a Service (SaaS) domain name. Call this operation only if the previous certificate request failed, or the current certificate is about to expire or has expired.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2696,9 +1419,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239650', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4DMKZ4', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4DMKZ4'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ @@ -2706,14 +1427,7 @@ 'name' => 'HostnameId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The ID of the SaaS domain name. Call the [ListCustomHostnames](~~3018667~~) operation to obtain the ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'title' => '', - 'example' => '1234567890123', - ], + 'schema' => ['description' => 'The ID of the SaaS domain name. Call the [ListCustomHostnames](~~3018667~~) operation to obtain the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1234567890123'], ], ], 'responses' => [ @@ -2721,12 +1435,7 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request. Alibaba Cloud generates this ID for each request.', - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n", - 'title' => '', - ], + 'RequestId' => ['description' => 'The unique ID of the request. Alibaba Cloud generates this ID for each request.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n", 'title' => ''], ], 'description' => '', 'title' => '', @@ -2736,33 +1445,13 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => '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.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], ], 404 => [ - [ - 'errorCode' => 'CustomHostname.NotFound', - 'errorMessage' => 'The custom hostname does not exist. Modify it and try again.', - 'description' => 'The custom hostname does not exist. Modify it and try again.', - ], + ['errorCode' => 'CustomHostname.NotFound', 'errorMessage' => 'The custom hostname does not exist. Modify it and try again.', 'description' => 'The custom hostname does not exist. Modify it and try again.'], ], ], 'eventInfo' => [ @@ -2770,20 +1459,33 @@ 'eventNames' => [], ], 'title' => 'ApplyCustomHostnameCertificate', + 'summary' => 'Requests a new free certificate for a Software as a Service (SaaS) domain name. Call this operation only if the previous certificate request failed, or the current certificate is about to expire or has expired.', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApplyCustomHostnameCertificate'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:ApplyCustomHostnameCertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\\\n\\"\\n}","type":"json"}]', + 'translator' => 'machine', ], 'BatchCreateRecords' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Creates multiple DNS records in a batch. Multiple record types are supported.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2796,197 +1498,69 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239587', - 'abilityTreeNodes' => [ - 'FEATUREdcdnVFT29S', - ], + 'abilityTreeNodes' => ['FEATUREdcdnVFT29S'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'RecordList', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The list of DNS records to be created.'."\n", + 'description' => 'The list of DNS records to create.', 'type' => 'array', 'items' => [ - 'description' => 'A single record object that contains specific configuration information.'."\n", + 'description' => 'A single record object that contains the specific configuration of the record.', 'type' => 'object', 'properties' => [ - 'RecordName' => [ - 'description' => 'The record name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'www.example.com', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The DNS type of the record.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'A/AAAA', - 'title' => '', - ], - 'Proxied' => [ - 'description' => 'Specifies whether to proxy the record. Only CNAME and A/AAAA records can be proxied. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - 'title' => '', - ], - 'SourceType' => [ - 'description' => 'The origin type for the CNAME record. This parameter is required when you add a CNAME record. Valid values:'."\n" - ."\n" - .'* **OSS**: OSS bucket.'."\n" - .'* **S3**: S3 bucket.'."\n" - .'* **LB**: load balancer.'."\n" - .'* **OP**: origin pool.'."\n" - .'* **Domain**: domain name.'."\n" - ."\n" - .'If you do not pass this parameter or if you leave its value empty, Domain is used by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OSS', - 'title' => '', - ], - 'BizName' => [ - 'description' => 'The business scenario of the record for acceleration. Valid values:'."\n" - ."\n" - .'* **image_video**'."\n" - .'* **api**'."\n" - .'* **web**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'web', - 'title' => '', - ], + 'RecordName' => ['description' => 'The record name.', 'type' => 'string', 'required' => true, 'example' => 'www.example.com', 'title' => ''], + 'Type' => ['description' => 'The DNS type of the record.', 'type' => 'string', 'required' => true, 'example' => 'A/AAAA', 'title' => ''], + 'Proxied' => ['description' => 'Specifies whether to enable proxied acceleration for the record. Only CNAME records and A/AAAA records support proxied acceleration. Valid values:'."\n" + .'- **true**: Proxied acceleration is enabled.'."\n" + .'- **false**: Proxied acceleration is disabled.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], + 'SourceType' => ['description' => 'The origin type of the CNAME record. This parameter is required when you add a CNAME record. Valid values:'."\n" + ."\n" + .'- **OSS**: OSS origin.'."\n" + .'- **S3**: S3 origin.'."\n" + .'- **LB**: load balancing origin.'."\n" + .'- **OP**: IPAM pool origin.'."\n" + .'- **Domain**: common domain name origin.'."\n" + ."\n" + .'If this parameter is left empty or not specified, the default value is Domain, which indicates a common domain name origin.', 'type' => 'string', 'required' => false, 'example' => 'OSS', 'title' => ''], + 'BizName' => ['description' => 'The business scenario for record acceleration. Valid values:'."\n" + .'- **image_video**: video and image.'."\n" + .'- **api**: API.'."\n" + .'- **web**: web page.', 'type' => 'string', 'required' => false, 'example' => 'web', 'title' => ''], 'Data' => [ - 'description' => 'The DNS information of the record. Enter fields based on the record type.'."\n", + 'description' => 'The DNS information of the record. Different fields are required based on the record type.', 'type' => 'object', 'properties' => [ - 'Usage' => [ - 'description' => 'The usage identifier of the record. Valid values: 0 to 255. Applicable to SMIMEA and TLSA records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], - 'Fingerprint' => [ - 'description' => 'The public key fingerprint of the record. Applicable to SSHFP records.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abcdef1234567890', - 'title' => '', - ], - 'Priority' => [ - 'description' => 'The priority of the record. Valid values: 0 to 65535. A smaller value indicates a higher priority. This parameter is required when you add MX, SRV, and URI records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - 'title' => '', - ], - 'Port' => [ - 'description' => 'The port of the record. Valid values: 0 to 65535. Exclusive to SRV records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], - 'Flag' => [ - 'description' => 'The Flag for a CAA record indicates its priority and how it is processed. Valid values: 0 to 255.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '128', - 'title' => '', - ], - 'Algorithm' => [ - 'description' => 'The encryption algorithm used for the record. Valid values: 0 to 255. Applicable to CERT and SSHFP records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], - 'Weight' => [ - 'description' => 'The weight of the record. Valid values: 0 to 65,535. Applicable to SRV and URI records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The certificate type of the record (in CERT records), or the public key type (in SSHFP records).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], - 'MatchingType' => [ - 'description' => 'The algorithm policy used to match or validate the certificate. Valid values: 0 to 255. Applicable to SMIMEA, and TLSA records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], - 'Value' => [ - 'description' => 'The record value or part of the record content. A/AAAA: the IP address being pointed to. CNAME: the target domain name being pointed to. MX: valid target mail server domain name. TXT: valid text string. CAA: valid certificate authority domain name. SRV: valid target host domain name. URI: valid URI string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'example.com', - 'title' => '', - ], - 'KeyTag' => [ - 'description' => 'The public key identification for the record. Valid values: 0 to 65535. Applicable to CERT records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], - 'Tag' => [ - 'description' => 'The tag of a CAA record, which indicates its specific type and purpose, such as issue, issuewild, and iodef.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'issue', - 'title' => '', - ], - 'Certificate' => [ - 'description' => 'The public key of the certificate. Applicable to CERT, SMIMEA, and TLSA records.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dGVzdGFkYWxrcw==', - 'title' => '', - ], - 'Selector' => [ - 'description' => 'The type of certificate or public key. Valid values: 0 to 255. Applicable to SMIMEA and TLSA records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'Usage' => ['description' => 'The usage identifier of the record. Value range: **0 to 255**. This parameter applies to SMIMEA and TLSA records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'Fingerprint' => ['description' => 'The public key fingerprint of the record. This parameter applies to SSHFP records.', 'type' => 'string', 'required' => false, 'example' => 'abcdef1234567890', 'title' => ''], + 'Priority' => ['description' => 'The priority of the record. Value range: **0 to 65535**. A smaller value indicates a higher priority. This parameter is required when you add MX, SRV, or URI records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], + 'Port' => ['description' => 'The port of the record. Value range: **0 to 65535**. This parameter applies only to SRV records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'Flag' => ['description' => 'The flag of the CAA record, which indicates its priority and processing method. Value range: **0 to 255**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '128', 'title' => ''], + 'Algorithm' => ['description' => 'The encryption algorithm used by the record. Value range: **0 to 255**. This parameter applies to CERT and SSHFP records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'Weight' => ['description' => 'The weight of the record. Value range: **0 to 65535**. This parameter applies to SRV and URI records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'Type' => ['description' => 'The certificate type (for CERT records) or public key type (for SSHFP records) of the record.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'MatchingType' => ['description' => 'The algorithm policy used to match or verify certificates. Value range: **0 to 255**. This parameter applies to SMIMEA and TLSA records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'Value' => ['description' => 'The record value or partial content. The meaning varies by record type:'."\n" + .'- **A/AAAA**: the IP address.'."\n" + .'- **CNAME**: the target domain name.'."\n" + .'- **MX**: a valid target mail server domain name.'."\n" + .'- **TXT**: a valid text string.'."\n" + .'- **CAA**: a valid certification authority domain name.'."\n" + .'- **SRV**: a valid target host domain name.'."\n" + .'- **URI**: a valid URI string.', 'type' => 'string', 'required' => false, 'example' => 'example.com', 'title' => ''], + 'KeyTag' => ['description' => 'The public key identifier of the record. Value range: **0 to 65535**. This parameter applies to CERT records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'Tag' => ['description' => 'The tag of the CAA record, which indicates its specific type and purpose, such as issue, issuewild, or iodef.', 'type' => 'string', 'required' => false, 'example' => 'issue', 'title' => ''], + 'Certificate' => ['description' => 'The public key certificate information of the record. This parameter applies to CERT, SMIMEA, and TLSA records.', 'type' => 'string', 'required' => false, 'example' => 'dGVzdGFkYWxrcw==', 'title' => ''], + 'Selector' => ['description' => 'The type of certificate or public key used by the record. Value range: **0 to 255**. This parameter applies to SMIMEA and TLSA records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], 'required' => true, 'example' => '{'."\n" @@ -2994,63 +1568,26 @@ .'}', 'title' => '', ], - 'Ttl' => [ - 'description' => 'The TTL of the record. Unit: seconds. If the value is 1, the TTL of the record is determined by the system.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '60', - 'title' => '', - ], + 'Ttl' => ['description' => 'The time-to-live (TTL) of the record, in seconds. A value of 1 indicates that the TTL is set to automatic.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '60', 'title' => ''], 'AuthConf' => [ + 'description' => 'The origin authentication information of the CNAME record.', 'type' => 'object', 'properties' => [ - 'SecretKey' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The SecretKey of the account to which the origin server belongs. This value must be provided when the origin server type is OSS and the authentication type is private cross-account read, or when the origin server type is S3 and the authentication type is private read.', - 'example' => 'VIxuvJSA2S03f******kp208dy5w7'."\n", - 'title' => '', - ], - 'Version' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The signature algorithm version. This parameter is required when the source type is S3 and the source authentication type is private-read. The following versions are supported: '."\n" - .'- **v2** '."\n" - .'- **v4** '."\n" - ."\n" - .'If this parameter is not specified, the default value is v4.', - 'example' => 'v4', - 'title' => '', - ], - 'Region' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The area to which the source belongs. This value must be provided when the source type is S3. You can obtain the correct area from the official S3 website.', - 'example' => 'us-east-1'."\n", - 'title' => '', - ], - 'AuthType' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The source authentication type. Different source types support different authentication types. The source type refers to the SourceType parameter in this API. When the source type is OSS or S3, you must specify the source authentication type. Valid values are: '."\n" - .'- **public**: public-read. Select this value when the source type is OSS or S3 and the source is publicly readable. '."\n" - .'- **private**: private-read. Select this value when the source type is S3 and the source is privately readable. '."\n" - .'- **private_same_account**: private-read within the same Alibaba Cloud account. Select this value when the source type is OSS, the source is privately readable, and it resides under the same Alibaba Cloud account. '."\n" - .'- **private_cross_account**: private-read across different Alibaba Cloud accounts. Select this value when the source type is OSS, the source is privately readable, and it resides under a different Alibaba Cloud account.', - 'example' => 'private', - 'title' => '', - ], - 'AccessKey' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The AccessKey of the Alibaba Cloud account to which the source belongs. This value must be provided when the source type is OSS and the source authentication type is private_cross_account, or when the source type is S3 and the source authentication type is private-read.', - 'example' => 'u0Nkg5gBK*******QF5wvKMM504JUHt'."\n", - 'title' => '', - ], + 'SecretKey' => ['description' => 'The SecretKey of the account to which the origin belongs. This parameter is required when the origin type is OSS and the authentication type is private cross-account read, or when the origin type is S3 and the authentication type is private read.', 'type' => 'string', 'required' => false, 'example' => 'VIxuvJSA2S03f******kp208dy5w7'."\n", 'title' => ''], + 'Version' => ['description' => 'The signature algorithm version. This parameter is available when the origin type is S3 and the authentication type is private read. Valid values:'."\n" + .'- **v2**'."\n" + .'- **v4**'."\n" + ."\n" + .'Default value: v4.', 'type' => 'string', 'required' => false, 'example' => 'v4', 'title' => ''], + 'Region' => ['description' => 'The region of the origin. This parameter is required when the origin type is S3. Obtain the region from the official S3 website.', 'type' => 'string', 'required' => false, 'example' => 'us-east-1'."\n", 'title' => ''], + 'AuthType' => ['description' => 'The origin authentication type. Different origin types support different authentication types. The origin type refers to the SourceType parameter in this operation. When the origin type is OSS or S3, you must specify the authentication type. Valid values:'."\n" + .'- **public**: public read. Select this value when the origin type is OSS or S3 and the origin allows public read access.'."\n" + .'- **private**: private read. Select this value when the origin type is S3 and the origin allows only private read access.'."\n" + .'- **private_same_account**: private same-account read. Select this value when the origin type is OSS, the origin is under the same Alibaba Cloud account, and the origin allows only private read access.'."\n" + .'- **private_cross_account**: private cross-account read. Select this value when the origin type is OSS, the origin is under a different Alibaba Cloud account, and the origin allows only private read access.', 'type' => 'string', 'required' => false, 'example' => 'private', 'title' => ''], + 'AccessKey' => ['description' => 'The AccessKey of the account to which the origin belongs. This parameter is required when the origin type is OSS and the authentication type is private cross-account read, or when the origin type is S3 and the authentication type is private read.', 'type' => 'string', 'required' => false, 'example' => 'u0Nkg5gBK*******QF5wvKMM504JUHt'."\n", 'title' => ''], ], 'required' => false, - 'description' => 'Authentication information for the origin server of the CNAME record.', 'title' => '', 'example' => '', ], @@ -3068,199 +1605,69 @@ 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response structure for the batch record creation operation.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2430E05E-1340-5773-B5E1-B743929F46F2', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2430E05E-1340-5773-B5E1-B743929F46F2', 'title' => ''], 'RecordResultList' => [ - 'description' => 'The records that have been created and failed to be created.'."\n", + 'description' => 'The list of record creation results, including details of successfully and unsuccessfully created records.', 'type' => 'object', 'properties' => [ 'Success' => [ - 'description' => 'The records that have been created.'."\n", + 'description' => 'The list of successfully created records.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'RecordName' => [ - 'description' => 'The record name.'."\n", - 'type' => 'string', - 'example' => 'www.example.com', - 'title' => '', - ], - 'Proxied' => [ - 'description' => 'Indicates whether the record is proxied. Only CNAME and A/AAAA records can be proxied. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], - 'Description' => [ - 'description' => 'The result description.'."\n", - 'type' => 'string', - 'example' => 'success', - 'title' => '', - ], - 'RecordType' => [ - 'description' => 'The DNS type of the record, such as **A/AAAA, CNAME, and TXT**.'."\n", - 'type' => 'string', - 'example' => 'A/AAAA', - 'title' => '', - ], - 'SourceType' => [ - 'description' => 'The origin type of the CNAME record. This field is left empty for other types of records. The type of the origin server. Valid values:'."\n" - ."\n" - .'* **OSS**: OSS bucket.'."\n" - .'* **S3**: S3 bucket.'."\n" - .'* **LB**: load balancer.'."\n" - .'* **OP**: origin pool.'."\n" - .'* **Domain**: domain name.'."\n", - 'type' => 'string', - 'example' => 'OSS', - 'title' => '', - ], + 'RecordName' => ['description' => 'The record name.', 'type' => 'string', 'example' => 'www.example.com', 'title' => ''], + 'Proxied' => ['description' => 'Specifies whether to enable proxied acceleration for the record. Only CNAME records and A/AAAA records support proxied acceleration. Valid values:'."\n" + .'- **true**: Proxied acceleration is enabled.'."\n" + .'- **false**: Proxied acceleration is disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Description' => ['description' => 'The description of the creation result.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RecordType' => ['description' => 'The DNS type of the record, such as **A/AAAA, CNAME, or TXT**.', 'type' => 'string', 'example' => 'A/AAAA', 'title' => ''], + 'SourceType' => ['description' => 'The origin type of the CNAME record. This field is empty for other record types. Valid values:'."\n" + .'- **OSS**: OSS origin.'."\n" + .'- **S3**: S3 origin.'."\n" + .'- **LB**: load balancing origin.'."\n" + .'- **OP**: IPAM pool origin.'."\n" + .'- **Domain**: common domain name origin.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Data' => [ - 'description' => 'The DNS record information.'."\n", + 'description' => 'The DNS information of the record.', 'type' => 'object', 'properties' => [ - 'Usage' => [ - 'description' => 'The usage identifier of the record. Valid values: 0 to 255. Applicable to SMIMEA and TLSA records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Fingerprint' => [ - 'description' => 'The public key fingerprint of the record. Applicable to SSHFP records.'."\n", - 'type' => 'string', - 'example' => 'abcdef1234567890', - 'title' => '', - ], - 'Priority' => [ - 'description' => 'The priority of the record. Valid values: 0 to 65535. A smaller value indicates a higher priority. Applicable to MX, SRV, and URI records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'Port' => [ - 'description' => 'The port of the record. Valid values: 0 to 65535. Exclusive to SRV records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Flag' => [ - 'description' => 'The flag bit of the record. Indicates its priority and handling method, used in CAA records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '128', - 'title' => '', - ], - 'Algorithm' => [ - 'description' => 'The encryption algorithm used for the record. Valid values: 0 to 255. Applicable to CERT and SSHFP records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Weight' => [ - 'description' => 'The weight of the record. Valid values: 0 to 65535. Applicable to SRV and URI records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The certificate type of the record (in CERT records), or the public key type (in SSHFP records).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'MatchingType' => [ - 'description' => 'The algorithm policy used to match or validate the certificate. Valid values: 0 to 255. Applicable to SMIMEA and TLSA records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Value' => [ - 'description' => 'The record value or part of the record content. This value is returned when the record is A/AAAA, CNAME, NS, MX, TXT, CAA, SRV, or URI. It has different meanings based on types of records:'."\n" - ."\n" - .'* **A/AAAA**: the IP addresses. Multiple IPs are separated by commas (,). There is at least one IPv4 address.'."\n" - .'* **CNAME**: the mapped domain name.'."\n" - .'* **NS**: the nameservers for the domain name.'."\n" - .'* **MX**: a valid domain name of the target mail server.'."\n" - .'* **TXT**: a valid text string.'."\n" - .'* **CAA**: a valid domain name of the certificate authority.'."\n" - .'* **SRV**: a valid domain name of the target host.'."\n" - .'* **URI**: a valid URI string.'."\n", - 'type' => 'string', - 'example' => 'example.com', - 'title' => '', - ], - 'KeyTag' => [ - 'description' => 'The public key identification for the record. Valid values: 0 to 65535. Applicable to CERT records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Tag' => [ - 'description' => 'The label of a CAA record, which indicates its specific type and purpose, such as issue, issuewild, and iodef.'."\n", - 'type' => 'string', - 'example' => 'issue', - 'title' => '', - ], - 'Certificate' => [ - 'description' => 'The public key of the certificate. Applicable to CERT, SMIMEA, and TLSA records.'."\n", - 'type' => 'string', - 'example' => 'dGVzdGFkYWxrcw==', - 'title' => '', - ], - 'Selector' => [ - 'description' => 'The type of certificate or public key. Valid values: 0 to 255. Applicable to SMIMEA and TLSA records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], + 'Usage' => ['description' => 'The usage identifier of the record. Value range: **0 to 255**. This parameter applies to SMIMEA and TLSA records.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Fingerprint' => ['description' => 'The public key fingerprint of the record. This parameter applies to SSHFP records.', 'type' => 'string', 'example' => 'abcdef1234567890', 'title' => ''], + 'Priority' => ['description' => 'The priority of the record. Value range: **0 to 65535**. A smaller value indicates a higher priority. This parameter applies to MX, SRV, and URI records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Port' => ['description' => 'The port of the record. Value range: **0 to 65535**. This parameter applies only to SRV records.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Flag' => ['description' => 'The flag of the record, which indicates its priority and processing method. This parameter applies to CAA records.', 'type' => 'integer', 'format' => 'int32', 'example' => '128', 'title' => ''], + 'Algorithm' => ['description' => 'The encryption algorithm used by the record. Value range: **0 to 255**. This parameter applies to CERT and SSHFP records.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Weight' => ['description' => 'The weight of the record. Value range: **0 to 65535**. This parameter applies to SRV and URI records.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Type' => ['description' => 'The certificate type (for CERT records) or public key type (for SSHFP records) of the record.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'MatchingType' => ['description' => 'The algorithm policy used to match or verify certificates. Value range: **0 to 255**. This parameter applies to SMIMEA and TLSA records.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Value' => ['description' => 'The record value or partial content. This parameter is included in A/AAAA, CNAME, NS, MX, TXT, CAA, SRV, and URI records. The meaning varies by record type:'."\n" + ."\n" + .'- **A/AAAA**: the IP address. Separate multiple IP addresses with commas (,). At least one IPv4 address is required.'."\n" + .'- **CNAME**: the target domain name.'."\n" + .'- **NS**: the name server of the specified domain name.'."\n" + .'- **MX**: a valid target mail server domain name.'."\n" + .'- **TXT**: a valid text string.'."\n" + .'- **CAA**: a valid certification authority domain name.'."\n" + .'- **SRV**: a valid target host domain name.'."\n" + .'- **URI**: a valid URI string.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'KeyTag' => ['description' => 'The public key identifier of the record. Value range: **0 to 65535**. This parameter applies to CERT records.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Tag' => ['description' => 'The tag of the CAA record, which indicates its specific type and purpose, such as issue, issuewild, or iodef.', 'type' => 'string', 'example' => 'issue', 'title' => ''], + 'Certificate' => ['description' => 'The public key certificate information of the record. This parameter applies to CERT, SMIMEA, and TLSA records.', 'type' => 'string', 'example' => 'dGVzdGFkYWxrcw==', 'title' => ''], + 'Selector' => ['description' => 'The type of certificate or public key used by the record. Value range: **0 to 255**. This parameter applies to SMIMEA and TLSA records.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], 'example' => '{"value":"1.1.1.1"}'."\n", 'title' => '', ], - 'BizName' => [ - 'description' => 'The business scenario of the record for acceleration. Valid values:'."\n" - ."\n" - .'* **image_video**'."\n" - .'* **api**'."\n" - .'* **web**'."\n", - 'type' => 'string', - 'example' => 'web', - 'title' => '', - ], - 'RecordId' => [ - 'description' => 'The record ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567890123', - 'title' => '', - ], - 'Ttl' => [ - 'description' => 'The TTL of the record. Unit: seconds. If the value is 1, the TTL of the record is determined by the system.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - 'title' => '', - ], + 'BizName' => ['description' => 'The business scenario for record acceleration. Valid values:'."\n" + .'- **image_video**: video and image.'."\n" + .'- **api**: API.'."\n" + .'- **web**: web page.', 'type' => 'string', 'example' => 'web', 'title' => ''], + 'RecordId' => ['description' => 'The record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''], + 'Ttl' => ['description' => 'The time-to-live (TTL) of the record, in seconds. A value of 1 indicates that the TTL is set to automatic.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], ], 'description' => '', 'title' => '', @@ -3270,185 +1677,61 @@ 'example' => '', ], 'Failed' => [ - 'description' => 'The records that failed to be created.'."\n", + 'description' => 'The list of records that failed to be created.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'RecordName' => [ - 'description' => 'The record name.'."\n", - 'type' => 'string', - 'example' => 'a.example.com', - 'title' => '', - ], - 'Proxied' => [ - 'description' => 'Indicates whether the record is proxied. Only CNAME and A/AAAA records can be proxied. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], - 'Description' => [ - 'description' => 'The result description.'."\n", - 'type' => 'string', - 'example' => '记录的名称非法', - 'title' => '', - ], - 'RecordType' => [ - 'description' => 'The DNS type of the record, such as **A/AAAA, CNAME, and TXT**.'."\n", - 'type' => 'string', - 'example' => 'A/AAAA', - 'title' => '', - ], - 'SourceType' => [ - 'description' => 'The origin type of the CNAME record. This field is left empty for other types of records. The type of the origin server. Valid values:'."\n" - ."\n" - .'* **OSS**: OSS bucket.'."\n" - .'* **S3**: S3 bucket.'."\n" - .'* **LB**: load balancer.'."\n" - .'* **OP**: origin pool.'."\n" - .'* **Domain**: domain name.'."\n", - 'type' => 'string', - 'example' => 'OSS', - 'title' => '', - ], + 'RecordName' => ['description' => 'The record name.', 'type' => 'string', 'example' => 'a.example.com', 'title' => ''], + 'Proxied' => ['description' => 'Indicates whether proxied acceleration is enabled for the record. Only CNAME records and A/AAAA records support proxied acceleration. Valid values:'."\n" + ."\n" + .'- **true**: Proxied acceleration is enabled.'."\n" + .'- **false**: Proxied acceleration is disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Description' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'The record name is invalid.', 'title' => ''], + 'RecordType' => ['description' => 'The DNS type of the record, such as **A/AAAA, CNAME, or TXT**.', 'type' => 'string', 'example' => 'A/AAAA', 'title' => ''], + 'SourceType' => ['description' => 'The origin type of the CNAME record. This field is empty for other record types. Valid values:'."\n" + .'- **OSS**: OSS origin.'."\n" + .'- **S3**: S3 origin.'."\n" + .'- **LB**: load balancing origin.'."\n" + .'- **OP**: IPAM pool origin.'."\n" + .'- **Domain**: common domain name origin.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], 'Data' => [ - 'description' => 'The DNS information about the record, which contains various types of record values and their related attributes.'."\n", + 'description' => 'The DNS information of the record, including record values and related properties for various record types.', 'type' => 'object', 'properties' => [ - 'Usage' => [ - 'description' => 'The usage identifier of the record. Valid values: 0 to 255. Applicable to SMIMEA and TLSA records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Fingerprint' => [ - 'description' => 'The public key fingerprint of the record. Applicable to SSHFP records.'."\n", - 'type' => 'string', - 'example' => 'abcdef1234567890', - 'title' => '', - ], - 'Priority' => [ - 'description' => 'The priority of the record. Valid values: 0 to 65535. A smaller value indicates a higher priority. Applicable to MX, SRV, and URI records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'Port' => [ - 'description' => 'The port number of the record, associated with the SRV record. Exclusive to SRV records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Flag' => [ - 'description' => 'The flag bit of the record. Indicates its priority and handling method, used in CAA records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '128', - 'title' => '', - ], - 'Algorithm' => [ - 'description' => 'The encryption algorithm used for the record. Valid values: 0 to 255. Applicable to CERT and SSHFP records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Weight' => [ - 'description' => 'The weight of the record. Applicable to SRV and URI records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The certificate type of the record (in CERT records), or the public key type (in SSHFP records).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'MatchingType' => [ - 'description' => 'The algorithm policy used to match or validate the certificate. Valid values: 0 to 255. Applicable to SMIMEA and TLSA records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'RSA', - 'title' => '', - ], - 'Value' => [ - 'description' => 'The record value or part of the record content. This value is returned when the record is A/AAAA, CNAME, NS, MX, TXT, CAA, SRV, or URI. It has different meanings based on types of records:'."\n" - ."\n" - .'* **A/AAAA**: the IP addresses. IP addresses are separated by commas (,). There is at least one IPv4 address.'."\n" - .'* **CNAME**: the mapped domain name.'."\n" - .'* **NS**: the nameservers for the domain name.'."\n" - .'* **MX**: a valid domain name of the target mail server.'."\n" - .'* **TXT**: a valid text string.'."\n" - .'* **CAA**: a valid domain name of the certificate authority.'."\n" - .'* **SRV**: a valid domain name of the target host.'."\n" - .'* **URI**: a valid URI string.'."\n", - 'type' => 'string', - 'example' => 'example.com', - 'title' => '', - ], - 'KeyTag' => [ - 'description' => 'The public key identification for the record. Valid values: 0 to 65535. Applicable to CERT records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Tag' => [ - 'description' => 'Indicates its priority and handling method, used in CAA records.'."\n", - 'type' => 'string', - 'example' => 'issue', - 'title' => '', - ], - 'Certificate' => [ - 'description' => 'The public key of the certificate. Applicable to CERT, SMIMEA, and TLSA records.'."\n", - 'type' => 'string', - 'example' => 'dGVzdGFkYWxrcw==', - 'title' => '', - ], - 'Selector' => [ - 'description' => 'The type of certificate or public key. Valid values: 0 to 255. Applicable to SMIMEA and TLSA records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], + 'Usage' => ['description' => 'The usage identifier of the record. Value range: **0 to 255**. This parameter applies to SMIMEA and TLSA records.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Fingerprint' => ['description' => 'The public key fingerprint of the record. This parameter applies to SSHFP records.', 'type' => 'string', 'example' => 'abcdef1234567890', 'title' => ''], + 'Priority' => ['description' => 'The priority of the record. Value range: **0 to 65535**. A smaller value indicates a higher priority. This parameter applies to MX, SRV, and URI records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Port' => ['description' => 'The port number of the record. This parameter applies only to SRV records.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Flag' => ['description' => 'The flag of the record, which indicates its priority and processing method. This parameter applies to CAA records.', 'type' => 'integer', 'format' => 'int32', 'example' => '128', 'title' => ''], + 'Algorithm' => ['description' => 'The encryption algorithm used by the record. Value range: **0 to 255**. This parameter applies to CERT and SSHFP records.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Weight' => ['description' => 'The weight of the record. This parameter applies to SRV and URI records.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Type' => ['description' => 'The certificate type (for CERT records) or public key type (for SSHFP records) of the record.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'MatchingType' => ['description' => 'The algorithm policy used to match or verify certificates. Value range: **0 to 255**. This parameter applies to SMIMEA and TLSA records.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Value' => ['description' => 'The record value or partial content. This parameter is included in A/AAAA, CNAME, NS, MX, TXT, CAA, SRV, and URI records. The meaning varies by record type:'."\n" + ."\n" + .'- **A/AAAA**: the IP address. Separate multiple IP addresses with commas (,). At least one IPv4 address is required.'."\n" + .'- **CNAME**: the target domain name.'."\n" + .'- **NS**: the name server of the specified domain name.'."\n" + .'- **MX**: a valid target mail server domain name.'."\n" + .'- **TXT**: a valid text string.'."\n" + .'- **CAA**: a valid certification authority domain name.'."\n" + .'- **SRV**: a valid target host domain name.'."\n" + .'- **URI**: a valid URI string.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'KeyTag' => ['description' => 'The public key identifier of the record. Value range: **0 to 65535**. This parameter applies to CERT records.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Tag' => ['description' => 'The tag of the CAA record, which indicates its specific type and purpose, such as issue, issuewild, or iodef.', 'type' => 'string', 'example' => 'issue', 'title' => ''], + 'Certificate' => ['description' => 'The public key certificate information of the record. This parameter applies to CERT, SMIMEA, and TLSA records.', 'type' => 'string', 'example' => 'dGVzdGFkYWxrcw==', 'title' => ''], + 'Selector' => ['description' => 'The type of certificate or public key used by the record. Value range: **0 to 255**. This parameter applies to SMIMEA and TLSA records.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], 'example' => '{"value":"2.2.2.2"}', 'title' => '', ], - 'BizName' => [ - 'description' => 'The business scenario of the record for acceleration. Valid values:'."\n" - ."\n" - .'* **image_video**'."\n" - .'* **api**'."\n" - .'* **web**'."\n", - 'type' => 'string', - 'example' => 'web', - 'title' => '', - ], - 'RecordId' => [ - 'description' => 'The record ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567890123', - 'title' => '', - ], - 'Ttl' => [ - 'description' => 'The TTL of the record. Unit: seconds. If the value is 1, the TTL of the record is determined by the system.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - 'title' => '', - ], + 'BizName' => ['description' => 'The business scenario for record acceleration. Valid values:'."\n" + .'- **image_video**: video and image.'."\n" + .'- **api**: API.'."\n" + .'- **web**: web page.', 'type' => 'string', 'example' => 'web', 'title' => ''], + 'RecordId' => ['description' => 'The record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''], + 'Ttl' => ['description' => 'The time-to-live (TTL) of the record, in seconds. A value of 1 indicates that the TTL is set to automatic.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], ], 'description' => '', 'title' => '', @@ -3457,13 +1740,7 @@ 'title' => '', 'example' => '', ], - 'TotalCount' => [ - 'description' => 'The total number of returned records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], + 'TotalCount' => ['description' => 'The total number of records in the creation operation.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], ], 'title' => '', 'example' => '', @@ -3476,487 +1753,112 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'QuotaExceed.RecordCount', - 'errorMessage' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.', - 'description' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.', - ], - [ - 'errorCode' => 'Site.ServiceBusy', - 'errorMessage' => 'This website is being configured. Try again later.', - 'description' => 'This website is being configured. Try again later.', - ], - [ - 'errorCode' => 'Record.Conflict', - 'errorMessage' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', - 'description' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'InvalidParameter.RecordsExceedLimit', - 'errorMessage' => 'The number of incoming records exceeds the maximum limit.', - 'description' => 'The number of incoming records exceeds the maximum limit.', - ], - [ - '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' => '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.', - ], - [ - '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' => 'The maximum number of records with the same name added in batches exceeds 5. Add records with the same name in batches or reduce the number of records with the same name added in batches.', - ], - [ - 'errorCode' => 'InvalidParameter.InvalidDSRecordName', - 'errorMessage' => 'Please add/import an NS record with the same name before adding this DS record.', - 'description' => 'Please add/import an NS record with the same name before adding this DS record', - ], - [ - 'errorCode' => 'InvalidParameter.InvalidBiz', - 'errorMessage' => 'The incoming parameter value of the business type is empty or incorrect.', - 'description' => 'The incoming parameter value of the business type is empty or incorrect.', - ], - [ - 'errorCode' => 'Record.RecordValueContainSourceInBlacklist', - 'errorMessage' => 'The record value contains the blacklist address, and the details can be submitted for work order consultation.', - 'description' => 'The record value contains the blacklist address, and the details can be submitted for work order consultation.', - ], - [ - 'errorCode' => 'InvalidParameter.InvalidRecordNameSuffix', - 'errorMessage' => 'If you add other records, the suffix of the host record must be the same as the site name.', - 'description' => 'If you add another record, the suffix of the host record must be the same as the site name. Please adjust and try again.', - ], - [ - 'errorCode' => 'InvalidParameter.RecordNameExceedLimit', - 'errorMessage' => 'The length of the record name exceeds the maximum limit.', - 'description' => 'The record name cannot exceed 200 characters.', - ], - [ - 'errorCode' => 'InvalidParameter.InvalidHostPolicy', - 'errorMessage' => 'The host parameter in the origin fetch request is invalid.', - 'description' => 'The host parameter in the origin fetch request is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.CnameSiteRecordUnsupport', - 'errorMessage' => 'The current record type is not supported for a website connected by CNAME setup.', - 'description' => 'You can only add A/AAAA and CNAME records to a website connected by CNAME setup.', - ], - [ - 'errorCode' => 'InvalidParameter.RecordCommentExceedLimit', - 'errorMessage' => 'The number of incoming record comment exceeds the maximum limit.', - 'description' => 'The record comment information is greater than 50 characters.', - ], - [ - 'errorCode' => 'QuotaExceed.WildCardRecord', - 'errorMessage' => 'The number of wildcard records exceeds the plan quota. Contact the sales team to increase your quota.', - 'description' => 'The number of wildcard records exceeds the plan quota. Contact the sales team to increase your quota.', - ], - [ - 'errorCode' => 'Record.AorAAAARecordValueContainInvalidIP', - 'errorMessage' => 'The A/AAAA record value contains the invalid IP.', - 'description' => 'When creating or editing an A/AAAA record, the record value contains an invalid IP.', - ], - [ - 'errorCode' => 'Record.AorAAAARecordValueIPExceedLimit', - 'errorMessage' => 'The number of IP addresses exceeds the limit for the A/AAAA record.', - 'description' => 'When creating or editing A/AAAA records, the number of IP addresses exceeds the limit. A host record only supports 8 IPv4 and 4 IPv6 IP addresses. Please adjust and try again.', - ], - [ - 'errorCode' => 'Record.CAARecordFlagExceedLimit', - 'errorMessage' => 'The value of the flag parameter for a CAA record is out of range.', - 'description' => 'The value of the flag parameter for a CAA record is out of range while creating or editing DNS record information.', - ], - [ - 'errorCode' => 'Record.CAARecordTagExceedLimit', - 'errorMessage' => 'The CAA record tag has illegal characters other than issue, issuewild, and iodef.', - 'description' => 'When creating or editing CAA records, illegal characters other than issue, issuewild, and iodef are passed in the tag value.', - ], - [ - 'errorCode' => 'Record.CERTRecordAlgorithmExceedLimit', - 'errorMessage' => 'The value of the algorithm parameter for the CERT record is out of range.', - 'description' => 'The value of the algorithm parameter for the CERT record is out of range while creating or editing DNS record information.', - ], - [ - 'errorCode' => 'Record.CERTRecordKeyTagExceedLimit', - 'errorMessage' => 'The value of the keyTag parameter for a CERT record is out of range.', - 'description' => 'The value of the keyTag parameter for a CERT record is out of range when creating or editing DNS record information.', - ], - [ - 'errorCode' => 'Record.CERTRecordTypeExceedLimit', - 'errorMessage' => 'The CERT record type is out of range.', - 'description' => 'The CERT record type parameter was out of range when creating or editing DNS record information.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'Record.CNameRecordValueCannotEqualExistedPoolSource', - 'errorMessage' => 'The CNAME record cannot be the origin of the added source address pool. Check and try again.', - 'description' => 'The CNAME record cannot be the origin of the added source address pool. Check and try again.', - ], - [ - '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' => 'The CNAME record cannot be the origin of an added record. Check the record values of other records and try again.', - ], - [ - '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' => 'The record value of a CNAME record cannot be exactly the same as the name of another existing Layer 4 proxy record.', - ], - [ - 'errorCode' => 'Record.CNameRecordValueCannotEqualOtherExistedRecord', - 'errorMessage' => 'The record value of a CNAME record cannot be the same as the name of another existing CNAME record.', - 'description' => 'The record value of a CNAME record cannot be the same as the name of another existing CNAME record.', - ], - [ - 'errorCode' => 'Record.CNameRecordValueCannotEqualHostRecord', - 'errorMessage' => 'The record value of the CNAME record cannot be exactly the same as the host record.', - 'description' => 'The record value of the CNAME record cannot be exactly the same as the host record. Please adjust and try again.', - ], - [ - 'errorCode' => 'Record.CNameRecordValueExceedLimit', - 'errorMessage' => 'The CNAME record value cannot exceed 253 characters, please delete and try again.', - 'description' => 'The record value cannot exceed 253 characters, please delete and try again.', - ], - [ - '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' => '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.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'Record.EmptyRecordValue', - 'errorMessage' => 'The record value is empty, please fill it in correctly and try again.', - 'description' => 'The record value is empty, please fill it in correctly and try again.', - ], - [ - 'errorCode' => 'Record.InvalidCertEncodeWithCERTRecord', - 'errorMessage' => 'The certificate value of the CERT record is not base64-encoded.', - 'description' => 'When you create or edit CERT record information, the certificate value of the CERT record is not base64-encoded.', - ], - [ - 'errorCode' => 'Record.InvalidFingerprintWithSSHFPRecord', - 'errorMessage' => 'The SSHFP record fingerprint value is not hexadecimal encoded.', - 'description' => 'When creating or editing SSHFP record information, the fingerprint value is not hexadecimal encoded.', - ], - [ - 'errorCode' => 'Record.InvalidIssueDataWithCAARecordTag', - 'errorMessage' => 'The tag of a CAA record can only be a semicolon or a valid domain name separated by semicolons.', - 'description' => 'When creating or editing CAA record information, the tag tag of a CAA record can only be a semicolon or a valid domain name separated by semicolons.', - ], - [ - 'errorCode' => 'Record.InvalidMailAddressWithCAARecordTag', - 'errorMessage' => 'The CAA record tag is prefixed with mailto:, it must be followed by a legal email address.', - 'description' => 'When creating or editing CAA record information, when Tag is iodef and Value is prefixed with mailto:, it must be followed by a legal email address.', - ], - [ - 'errorCode' => 'Record.InvalidSmimeaEncodeWithSMIMEARecord', - 'errorMessage' => 'The certificate value of the SMIMEA record is not base64-encoded.', - 'description' => 'When creating or editing SMIMEA record information, the certificate value of the SMIMEA record is not base64-encoded.', - ], - [ - 'errorCode' => 'Record.InvalidTslaEncodeWithTSLARecord', - 'errorMessage' => 'The certificate value passed in is not hexadecimal encoded with TSLA record.', - 'description' => 'When creating or editing TLSA record information, the certificate value passed in is not hexadecimal encoded.', - ], - [ - 'errorCode' => 'Record.InvalidURLWithURIRecord', - 'errorMessage' => 'The URI record value must be a valid URL address.', - 'description' => 'When creating or editing URI record information, the record value must be a valid URL address.', - ], - [ - 'errorCode' => 'Record.NoRecordNameConflictWithNSRecord', - 'errorMessage' => 'No record name can conflict with an NS record name.', - 'description' => 'No record name can conflict with an NS record name.', - ], - [ - 'errorCode' => 'Record.NSRecordCannotEqualSiteName', - 'errorMessage' => 'An NS record with the exact same name as the site name is not allowed.', - 'description' => 'Adding an NS record with the exact same name as the site name is not allowed.', - ], - [ - 'errorCode' => 'Record.OSSSourceInvalidAuthType', - 'errorMessage' => 'The recorded OSS origin station authentication type is not supported.', - 'description' => 'The recorded OSS origin station authentication type is not supported.', - ], - [ - 'errorCode' => 'Record.ParseJSONRecordValueFailed', - 'errorMessage' => 'The JSON data format of the record data is incorrect. Please adjust and try again.', - 'description' => 'The JSON data format of the record data is incorrect. Please adjust and try again.', - ], - [ - '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' => 'If the source station type of the record is source address pool, the input source address pool does not exist.', - ], - [ - 'errorCode' => 'Record.RecordNameConflictForSpecifiedRecordType', - 'errorMessage' => 'The A/AAAA and CNAME records cannot have the same name.', - 'description' => 'The A/AAAA and CNAME records cannot have the same name.', - ], - [ - 'errorCode' => 'Record.RecordNameConflictWithIPAName', - 'errorMessage' => 'The record name cannot have the same name as the Layer 4 proxy record.', - 'description' => 'When you create or edit DNS record information, the record name cannot have the same name as the Layer 4 proxy record.', - ], - [ - 'errorCode' => 'Record.RecordNameConflictWithLBName', - 'errorMessage' => 'The record name cannot be the same as the Server Load Balancer record name.', - 'description' => 'When creating or editing DNS record information, the record name cannot be the same as the Server Load Balancer record name.', - ], - [ - 'errorCode' => 'Record.RecordNameConflictWithNSRecord', - 'errorMessage' => 'The NS record name cannot be the same as any other type of record name.', - 'description' => 'When creating or editing DNS record information, the NS record name cannot be the same as any other type of record name.', - ], - [ - 'errorCode' => 'Record.RecordNameConflictWithPoolName', - 'errorMessage' => 'The record name cannot be the same as the source address pool record name.', - 'description' => 'When creating or editing DNS record information, the record name cannot be the same as the source address pool record name.', - ], - [ - 'errorCode' => 'Record.RecordNameInBlacklist', - 'errorMessage' => 'The record name is in blacklist.', - 'description' => 'The record name is in the blacklist and cannot be added.', - ], - [ - 'errorCode' => 'Record.S3SourceInvalidAuthRegion', - 'errorMessage' => 'The recorded S3 origin belongs to a region that is not in the supported range.', - 'description' => 'The recorded S3 origin belongs to a region that is not in the supported range.', - ], - [ - 'errorCode' => 'Record.S3SourceInvalidAuthType', - 'errorMessage' => 'The recorded S3 origin authentication type is not supported.', - 'description' => 'The recorded S3 origin authentication type is not supported.', - ], - [ - 'errorCode' => 'Record.S3SourceInvalidAuthVersion', - 'errorMessage' => 'The version of the authentication signature algorithm of the S3 origin is not supported.', - 'description' => 'The version of the authentication signature algorithm of the S3 origin is not supported.', - ], - [ - 'errorCode' => 'Record.SourceAccessKeyExceedLimit', - 'errorMessage' => 'The character length of the AccessKey parameter value for the record source station is out of range.', - 'description' => 'The character length of the AccessKey parameter value for the record source station is out of range.', - ], - [ - 'errorCode' => 'Record.SourceEmptyAK', - 'errorMessage' => 'The AccessKey of the account to which the origin site belongs is empty.', - 'description' => 'The AccessKey of the account to which the origin site belongs is empty.', - ], - [ - 'errorCode' => 'Record.SourceEmptyAuthConf', - 'errorMessage' => 'The authentication information of the origin station is empty.', - 'description' => 'The recorded authentication information of the origin station is empty.', - ], - [ - 'errorCode' => 'Record.SourceEmptySecretKey', - 'errorMessage' => 'The SecretKey of the account to which the recorded origin site belongs is empty.', - 'description' => 'The SecretKey of the account to which the recorded origin site belongs is empty.', - ], - [ - 'errorCode' => 'Record.SourceSecretKeyExceedLimit', - 'errorMessage' => 'The character length of the SecretKey parameter value for the record source station is out of range.', - 'description' => 'The character length of the SecretKey parameter value for the record source station is out of range.', - ], - [ - '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 host record name is not valid. The SRV host record name must begin with an underscore (-), followed by a lowercase letter (a-z), number (0-9), hyphen (-), followed by any character, followed by an underscore (-) and a lowercase letter, number, or hyphen.', - ], - [ - 'errorCode' => 'Record.SRVRecordPortExceedLimit', - 'errorMessage' => 'The SRV record port is out of range.', - 'description' => 'When creating or editing DNS record information, the SRV record port filled in is out of range.', - ], - [ - 'errorCode' => 'Record.SSHFPRecordAlgorithmExceedLimit', - 'errorMessage' => 'The algorithm parameter value for the SSHFP record is out of range.', - 'description' => 'The algorithm parameter value for the SSHFP record is out of range while creating or editing DNS record information.', - ], - [ - 'errorCode' => 'Record.TTLExceedLimit', - 'errorMessage' => 'The TTL parameter value for a record is out of range.', - 'description' => 'The TTL parameter value for a record is out of range while creating or editing DNS record information.', - ], - [ - 'errorCode' => 'Record.TXTRecordValueExceedLimit', - 'errorMessage' => 'The TXT record value cannot exceed 450 characters.', - 'description' => 'When you create or edit DNS record information, the TXT record value cannot exceed 450 characters.', - ], - [ - 'errorCode' => 'Record.TypeExceedLimitWithSSHFPRecord', - 'errorMessage' => 'The SSHFP record Type parameter value is out of range.', - 'description' => 'The SSHFP record Type parameter value is out of range while creating or editing DNS record information.', - ], - [ - 'errorCode' => 'Record.UnmatchedRecordNameContainDoubleConsecutiveDot', - 'errorMessage' => 'Illegal host record name. The host record cannot contain consecutive dot.', - 'description' => 'Illegal host record name. The host record cannot contain consecutive dot.', - ], - [ - 'errorCode' => 'Record.UnmatchedRecordNameForbidStarSev', - 'errorMessage' => 'Illegal host record name, SRV record name disallowed asterisk.', - 'description' => 'Illegal host record name, SRV record name disallowed asterisk.', - ], - [ - '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' => 'Illegal host record name. The \'@\' symbol can only appear at the top of the host record and can only be followed. Symbol, other strings are not allowed.', - ], - [ - 'errorCode' => 'Record.UnmatchedRecordNameInvalidNamePrefixSuffix', - 'errorMessage' => 'Illegal host record name. Host record values cannot start or end with a dot, a hyphens.', - 'description' => 'Illegal host record name. Host record values cannot start or end with a dot, a hyphens.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'Record.UnmatchedRecordNameSeperateStringTooLarge', - 'errorMessage' => 'Illegal host record name. The number of characters in each segment separated by dot cannot exceed 63.', - 'description' => 'Illegal host record name. The number of characters in each segment separated by \'.\' cannot exceed 63.', - ], - [ - 'errorCode' => 'Record.UnsupportedSourceType', - 'errorMessage' => 'The recorded source station type is not in the supported range.', - 'description' => 'The recorded source station type is not in the supported range.', - ], - [ - 'errorCode' => 'Record.UnsupportedType', - 'errorMessage' => 'The record type parameter is unsupported.', - 'description' => 'The record type parameter is incorrect. Please check the record type parameter.', - ], - [ - 'errorCode' => 'Record.ValidProxiedForSpecifedRecordType', - 'errorMessage' => 'Only A/AAAA and CNAME types support proxy acceleration.', - 'description' => 'When creating or editing a record, proxy acceleration is enabled in the proxy state. Only A/AAAA and CNAME types support proxy acceleration.', - ], - [ - 'errorCode' => 'Record.RecordUsageExceedLimit', - 'errorMessage' => 'The usage parameter value filled in is out of range.', - 'description' => 'When creating or editing DNS record information, the usage parameter value filled in is out of range.', - ], - [ - 'errorCode' => 'Record.RecordSelectorExceedLimit', - 'errorMessage' => 'The selector parameter value filled in is out of range.', - 'description' => 'While creating or editing DNS record information, the selector parameter value filled in is out of range.', - ], - [ - 'errorCode' => 'Record.RecordMatchingTypeExceedLimit', - 'errorMessage' => 'The matchingType parameter value filled in is out of range.', - 'description' => 'While creating or editing DNS record information, the matchingType parameter value filled in is out of range.', - ], - [ - 'errorCode' => 'Record.RecordPriorityExceedLimit', - 'errorMessage' => 'The record priority parameter value filled in is out of range.', - 'description' => 'When creating or editing DNS record information, the record priority parameter value filled in is out of range.', - ], - [ - 'errorCode' => 'Record.RecordWeightExceedLimit', - 'errorMessage' => 'The record weight parameter value filled in is out of range.', - 'description' => 'When creating or editing DNS record information, the record weight parameter value filled in is out of range.', - ], - [ - 'errorCode' => 'Record.RecordNameConflictWithSameRecordType', - 'errorMessage' => 'Record conflicts with an existing host record that has the same name and value.', - 'description' => 'Record conflicts with an existing host record that has the same name and value.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'InvalidParameter.CnameSiteRecordNoProxied', - 'errorMessage' => 'A non-proxied record was added for a website using a CNAME setup.', - 'description' => 'A non-proxied record was added for a website using a CNAME setup.', - ], - [ - 'errorCode' => 'Record.InvalidIodefDataWithCAARecordTag', - 'errorMessage' => 'The CAA record Tag value cannot start with mailto: or http:// or https.', - 'description' => 'When creating or editing CAA record information, the Tag value cannot start with mailto: http:// or 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' => 'The host record value cannot exist separately in various symbols, and can be added with any lowercase letters or numbers.'."\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 records cannot add all and asterisk prefixed records at the same time.', - ], - [ - 'errorCode' => 'Record.InvalidHTTPURLValueWithCAARecordTag', - 'errorMessage' => 'The CAA record is prefixed with http:// or https://, it must be followed by a valid URL.', - 'description' => 'When you create or edit a CAA record, if the Tag is `iodef` and the Value starts with `http://` or `https://`, it must be followed by a valid URL.', - ], - [ - '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' => 'Illegal host record character. Only lowercase a-z, uppercase A- Z, digits 0-9, \'-\', \'_\', \'.\', \'*\', and \'@\' are supported as valid characters in host records \',\' @ \'.'."\n", - ], - ], - ], - 'title' => 'Batch create DNS records'."\n", - 'summary' => 'Add DNS records in batch, supporting multiple record types. ', - 'description' => 'This API allows users to create or update multiple DNS record entries at once, suitable for scenarios that require managing a large number of DNS configurations. Supported record types include but are not limited to A/AAAA, CNAME, NS, MX, TXT, CAA, SRV, and URI. Detailed configuration items are provided to meet specific requirements, such as Priority, Flag, Tag, and Weight. Additionally, for specific record types like CERT, SSHFP, SMIMEA, and TLSA, advanced settings such as certificate information and encryption algorithms are supported. '."\n" + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'QuotaExceed.RecordCount', 'errorMessage' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.', 'description' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.'], + ['errorCode' => 'Site.ServiceBusy', 'errorMessage' => 'This website is being configured. Try again later.', 'description' => 'This website is being configured. Try again later.'], + ['errorCode' => 'Record.Conflict', 'errorMessage' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', 'description' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.'], + ['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' => '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.'], + ['errorCode' => 'InvalidParameter.RecordsExceedLimit', 'errorMessage' => 'The number of incoming records exceeds the maximum limit.', 'description' => 'The number of incoming records exceeds the maximum limit.'], + ['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' => '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.'], + ['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' => 'The maximum number of records with the same name added in batches exceeds 5. Add records with the same name in batches or reduce the number of records with the same name added in batches.'], + ['errorCode' => 'InvalidParameter.InvalidDSRecordName', 'errorMessage' => 'Please add/import an NS record with the same name before adding this DS record.', 'description' => 'Please add/import an NS record with the same name before adding this DS record'], + ['errorCode' => 'InvalidParameter.InvalidBiz', 'errorMessage' => 'The incoming parameter value of the business type is empty or incorrect.', 'description' => 'The incoming parameter value of the business type is empty or incorrect.'], + ['errorCode' => 'Record.RecordValueContainSourceInBlacklist', 'errorMessage' => 'The record value contains the blacklist address, and the details can be submitted for work order consultation.', 'description' => 'The record value contains the blacklist address, and the details can be submitted for work order consultation.'], + ['errorCode' => 'InvalidParameter.InvalidRecordNameSuffix', 'errorMessage' => 'If you add other records, the suffix of the host record must be the same as the site name.', 'description' => 'If you add another record, the suffix of the host record must be the same as the site name. Please adjust and try again.'], + ['errorCode' => 'InvalidParameter.RecordNameExceedLimit', 'errorMessage' => 'The length of the record name exceeds the maximum limit.', 'description' => 'The record name cannot exceed 200 characters.'], + ['errorCode' => 'InvalidParameter.InvalidHostPolicy', 'errorMessage' => 'The host parameter in the origin fetch request is invalid.', 'description' => 'The host parameter in the origin fetch request is invalid.'], + ['errorCode' => 'InvalidParameter.CnameSiteRecordUnsupport', 'errorMessage' => 'The current record type is not supported for a website connected by CNAME setup.', 'description' => 'You can only add A/AAAA and CNAME records to a website connected by CNAME setup.'], + ['errorCode' => 'InvalidParameter.RecordCommentExceedLimit', 'errorMessage' => 'The number of incoming record comment exceeds the maximum limit.', 'description' => 'The record comment information is greater than 50 characters.'], + ['errorCode' => 'QuotaExceed.WildCardRecord', 'errorMessage' => 'The number of wildcard records exceeds the plan quota. Contact the sales team to increase your quota.', 'description' => 'The number of wildcard records exceeds the plan quota. Contact the sales team to increase your quota.'], + ['errorCode' => 'Record.AorAAAARecordValueContainInvalidIP', 'errorMessage' => 'The A/AAAA record value contains the invalid IP.', 'description' => 'When creating or editing an A/AAAA record, the record value contains an invalid IP.'], + ['errorCode' => 'Record.AorAAAARecordValueIPExceedLimit', 'errorMessage' => 'The number of IP addresses exceeds the limit for the A/AAAA record.', 'description' => 'When creating or editing A/AAAA records, the number of IP addresses exceeds the limit. A host record only supports 8 IPv4 and 4 IPv6 IP addresses. Please adjust and try again.'], + ['errorCode' => 'Record.CAARecordFlagExceedLimit', 'errorMessage' => 'The value of the flag parameter for a CAA record is out of range.', 'description' => 'The value of the flag parameter for a CAA record is out of range while creating or editing DNS record information.'], + ['errorCode' => 'Record.CAARecordTagExceedLimit', 'errorMessage' => 'The CAA record tag has illegal characters other than issue, issuewild, and iodef.', 'description' => 'When creating or editing CAA records, illegal characters other than issue, issuewild, and iodef are passed in the tag value.'], + ['errorCode' => 'Record.CERTRecordAlgorithmExceedLimit', 'errorMessage' => 'The value of the algorithm parameter for the CERT record is out of range.', 'description' => 'The value of the algorithm parameter for the CERT record is out of range while creating or editing DNS record information.'], + ['errorCode' => 'Record.CERTRecordKeyTagExceedLimit', 'errorMessage' => 'The value of the keyTag parameter for a CERT record is out of range.', 'description' => 'The value of the keyTag parameter for a CERT record is out of range when creating or editing DNS record information.'], + ['errorCode' => 'Record.CERTRecordTypeExceedLimit', 'errorMessage' => 'The CERT record type is out of range.', 'description' => 'The CERT record type parameter was out of range when creating or editing DNS record information.'], + ['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' => '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.'], + ['errorCode' => 'Record.CNameRecordValueCannotEqualExistedPoolSource', 'errorMessage' => 'The CNAME record cannot be the origin of the added source address pool. Check and try again.', 'description' => 'The CNAME record cannot be the origin of the added source address pool. Check and try again.'], + ['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' => 'The CNAME record cannot be the origin of an added record. Check the record values of other records and try again.'], + ['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' => 'The record value of a CNAME record cannot be exactly the same as the name of another existing Layer 4 proxy record.'], + ['errorCode' => 'Record.CNameRecordValueCannotEqualOtherExistedRecord', 'errorMessage' => 'The record value of a CNAME record cannot be the same as the name of another existing CNAME record.', 'description' => 'The record value of a CNAME record cannot be the same as the name of another existing CNAME record.'], + ['errorCode' => 'Record.CNameRecordValueCannotEqualHostRecord', 'errorMessage' => 'The record value of the CNAME record cannot be exactly the same as the host record.', 'description' => 'The record value of the CNAME record cannot be exactly the same as the host record. Please adjust and try again.'], + ['errorCode' => 'Record.CNameRecordValueExceedLimit', 'errorMessage' => 'The CNAME record value cannot exceed 253 characters, please delete and try again.', 'description' => 'The record value cannot exceed 253 characters, please delete and try again.'], + ['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' => '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.'], + ['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' => '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.'], + ['errorCode' => 'Record.EmptyRecordValue', 'errorMessage' => 'The record value is empty, please fill it in correctly and try again.', 'description' => 'The record value is empty, please fill it in correctly and try again.'], + ['errorCode' => 'Record.InvalidCertEncodeWithCERTRecord', 'errorMessage' => 'The certificate value of the CERT record is not base64-encoded.', 'description' => 'When you create or edit CERT record information, the certificate value of the CERT record is not base64-encoded.'], + ['errorCode' => 'Record.InvalidFingerprintWithSSHFPRecord', 'errorMessage' => 'The SSHFP record fingerprint value is not hexadecimal encoded.', 'description' => 'When creating or editing SSHFP record information, the fingerprint value is not hexadecimal encoded.'], + ['errorCode' => 'Record.InvalidIssueDataWithCAARecordTag', 'errorMessage' => 'The tag of a CAA record can only be a semicolon or a valid domain name separated by semicolons.', 'description' => 'When creating or editing CAA record information, the tag tag of a CAA record can only be a semicolon or a valid domain name separated by semicolons.'], + ['errorCode' => 'Record.InvalidMailAddressWithCAARecordTag', 'errorMessage' => 'The CAA record tag is prefixed with mailto:, it must be followed by a legal email address.', 'description' => 'When creating or editing CAA record information, when Tag is iodef and Value is prefixed with mailto:, it must be followed by a legal email address.'], + ['errorCode' => 'Record.InvalidSmimeaEncodeWithSMIMEARecord', 'errorMessage' => 'The certificate value of the SMIMEA record is not base64-encoded.', 'description' => 'When creating or editing SMIMEA record information, the certificate value of the SMIMEA record is not base64-encoded.'], + ['errorCode' => 'Record.InvalidTslaEncodeWithTSLARecord', 'errorMessage' => 'The certificate value passed in is not hexadecimal encoded with TSLA record.', 'description' => 'When creating or editing TLSA record information, the certificate value passed in is not hexadecimal encoded.'], + ['errorCode' => 'Record.InvalidURLWithURIRecord', 'errorMessage' => 'The URI record value must be a valid URL address.', 'description' => 'When creating or editing URI record information, the record value must be a valid URL address.'], + ['errorCode' => 'Record.NoRecordNameConflictWithNSRecord', 'errorMessage' => 'No record name can conflict with an NS record name.', 'description' => 'No record name can conflict with an NS record name.'], + ['errorCode' => 'Record.NSRecordCannotEqualSiteName', 'errorMessage' => 'An NS record with the exact same name as the site name is not allowed.', 'description' => 'Adding an NS record with the exact same name as the site name is not allowed.'], + ['errorCode' => 'Record.OSSSourceInvalidAuthType', 'errorMessage' => 'The recorded OSS origin station authentication type is not supported.', 'description' => 'The recorded OSS origin station authentication type is not supported.'], + ['errorCode' => 'Record.ParseJSONRecordValueFailed', 'errorMessage' => 'The JSON data format of the record data is incorrect. Please adjust and try again.', 'description' => 'The JSON data format of the record data is incorrect. Please adjust and try again.'], + ['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' => 'If the source station type of the record is source address pool, the input source address pool does not exist.'], + ['errorCode' => 'Record.RecordNameConflictForSpecifiedRecordType', 'errorMessage' => 'The A/AAAA and CNAME records cannot have the same name.', 'description' => 'The A/AAAA and CNAME records cannot have the same name.'], + ['errorCode' => 'Record.RecordNameConflictWithIPAName', 'errorMessage' => 'The record name cannot have the same name as the Layer 4 proxy record.', 'description' => 'When you create or edit DNS record information, the record name cannot have the same name as the Layer 4 proxy record.'], + ['errorCode' => 'Record.RecordNameConflictWithLBName', 'errorMessage' => 'The record name cannot be the same as the Server Load Balancer record name.', 'description' => 'When creating or editing DNS record information, the record name cannot be the same as the Server Load Balancer record name.'], + ['errorCode' => 'Record.RecordNameConflictWithNSRecord', 'errorMessage' => 'The NS record name cannot be the same as any other type of record name.', 'description' => 'When creating or editing DNS record information, the NS record name cannot be the same as any other type of record name.'], + ['errorCode' => 'Record.RecordNameConflictWithPoolName', 'errorMessage' => 'The record name cannot be the same as the source address pool record name.', 'description' => 'When creating or editing DNS record information, the record name cannot be the same as the source address pool record name.'], + ['errorCode' => 'Record.RecordNameInBlacklist', 'errorMessage' => 'The record name is in blacklist.', 'description' => 'The record name is in the blacklist and cannot be added.'], + ['errorCode' => 'Record.S3SourceInvalidAuthRegion', 'errorMessage' => 'The recorded S3 origin belongs to a region that is not in the supported range.', 'description' => 'The recorded S3 origin belongs to a region that is not in the supported range.'], + ['errorCode' => 'Record.S3SourceInvalidAuthType', 'errorMessage' => 'The recorded S3 origin authentication type is not supported.', 'description' => 'The recorded S3 origin authentication type is not supported.'], + ['errorCode' => 'Record.S3SourceInvalidAuthVersion', 'errorMessage' => 'The version of the authentication signature algorithm of the S3 origin is not supported.', 'description' => 'The version of the authentication signature algorithm of the S3 origin is not supported.'], + ['errorCode' => 'Record.SourceAccessKeyExceedLimit', 'errorMessage' => 'The character length of the AccessKey parameter value for the record source station is out of range.', 'description' => 'The character length of the AccessKey parameter value for the record source station is out of range.'], + ['errorCode' => 'Record.SourceEmptyAK', 'errorMessage' => 'The AccessKey of the account to which the origin site belongs is empty.', 'description' => 'The AccessKey of the account to which the origin site belongs is empty.'], + ['errorCode' => 'Record.SourceEmptyAuthConf', 'errorMessage' => 'The authentication information of the origin station is empty.', 'description' => 'The recorded authentication information of the origin station is empty.'], + ['errorCode' => 'Record.SourceEmptySecretKey', 'errorMessage' => 'The SecretKey of the account to which the recorded origin site belongs is empty.', 'description' => 'The SecretKey of the account to which the recorded origin site belongs is empty.'], + ['errorCode' => 'Record.SourceSecretKeyExceedLimit', 'errorMessage' => 'The character length of the SecretKey parameter value for the record source station is out of range.', 'description' => 'The character length of the SecretKey parameter value for the record source station is out of range.'], + ['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 host record name is not valid. The SRV host record name must begin with an underscore (-), followed by a lowercase letter (a-z), number (0-9), hyphen (-), followed by any character, followed by an underscore (-) and a lowercase letter, number, or hyphen.'], + ['errorCode' => 'Record.SRVRecordPortExceedLimit', 'errorMessage' => 'The SRV record port is out of range.', 'description' => 'When creating or editing DNS record information, the SRV record port filled in is out of range.'], + ['errorCode' => 'Record.SSHFPRecordAlgorithmExceedLimit', 'errorMessage' => 'The algorithm parameter value for the SSHFP record is out of range.', 'description' => 'The algorithm parameter value for the SSHFP record is out of range while creating or editing DNS record information.'], + ['errorCode' => 'Record.TTLExceedLimit', 'errorMessage' => 'The TTL parameter value for a record is out of range.', 'description' => 'The TTL parameter value for a record is out of range while creating or editing DNS record information.'], + ['errorCode' => 'Record.TXTRecordValueExceedLimit', 'errorMessage' => 'The TXT record value cannot exceed 450 characters.', 'description' => 'When you create or edit DNS record information, the TXT record value cannot exceed 450 characters.'], + ['errorCode' => 'Record.TypeExceedLimitWithSSHFPRecord', 'errorMessage' => 'The SSHFP record Type parameter value is out of range.', 'description' => 'The SSHFP record Type parameter value is out of range while creating or editing DNS record information.'], + ['errorCode' => 'Record.UnmatchedRecordNameContainDoubleConsecutiveDot', 'errorMessage' => 'Illegal host record name. The host record cannot contain consecutive dot.', 'description' => 'Illegal host record name. The host record cannot contain consecutive dot.'], + ['errorCode' => 'Record.UnmatchedRecordNameForbidStarSev', 'errorMessage' => 'Illegal host record name, SRV record name disallowed asterisk.', 'description' => 'Illegal host record name, SRV record name disallowed asterisk.'], + ['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' => 'Illegal host record name. The \'@\' symbol can only appear at the top of the host record and can only be followed. Symbol, other strings are not allowed.'], + ['errorCode' => 'Record.UnmatchedRecordNameInvalidNamePrefixSuffix', 'errorMessage' => 'Illegal host record name. Host record values cannot start or end with a dot, a hyphens.', 'description' => 'Illegal host record name. Host record values cannot start or end with a dot, a hyphens.'], + ['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' => '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.'], + ['errorCode' => 'Record.UnmatchedRecordNameSeperateStringTooLarge', 'errorMessage' => 'Illegal host record name. The number of characters in each segment separated by dot cannot exceed 63.', 'description' => 'Illegal host record name. The number of characters in each segment separated by \'.\' cannot exceed 63.'], + ['errorCode' => 'Record.UnsupportedSourceType', 'errorMessage' => 'The recorded source station type is not in the supported range.', 'description' => 'The recorded source station type is not in the supported range.'], + ['errorCode' => 'Record.UnsupportedType', 'errorMessage' => 'The record type parameter is unsupported.', 'description' => 'The record type parameter is incorrect. Please check the record type parameter.'], + ['errorCode' => 'Record.ValidProxiedForSpecifedRecordType', 'errorMessage' => 'Only A/AAAA and CNAME types support proxy acceleration.', 'description' => 'When creating or editing a record, proxy acceleration is enabled in the proxy state. Only A/AAAA and CNAME types support proxy acceleration.'], + ['errorCode' => 'Record.RecordUsageExceedLimit', 'errorMessage' => 'The usage parameter value filled in is out of range.', 'description' => 'When creating or editing DNS record information, the usage parameter value filled in is out of range.'], + ['errorCode' => 'Record.RecordSelectorExceedLimit', 'errorMessage' => 'The selector parameter value filled in is out of range.', 'description' => 'While creating or editing DNS record information, the selector parameter value filled in is out of range.'], + ['errorCode' => 'Record.RecordMatchingTypeExceedLimit', 'errorMessage' => 'The matchingType parameter value filled in is out of range.', 'description' => 'While creating or editing DNS record information, the matchingType parameter value filled in is out of range.'], + ['errorCode' => 'Record.RecordPriorityExceedLimit', 'errorMessage' => 'The record priority parameter value filled in is out of range.', 'description' => 'When creating or editing DNS record information, the record priority parameter value filled in is out of range.'], + ['errorCode' => 'Record.RecordWeightExceedLimit', 'errorMessage' => 'The record weight parameter value filled in is out of range.', 'description' => 'When creating or editing DNS record information, the record weight parameter value filled in is out of range.'], + ['errorCode' => 'Record.RecordNameConflictWithSameRecordType', 'errorMessage' => 'Record conflicts with an existing host record that has the same name and value.', 'description' => 'Record conflicts with an existing host record that has the same name and value.'], + ['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' => '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.'], + ['errorCode' => 'InvalidParameter.CnameSiteRecordNoProxied', 'errorMessage' => 'A non-proxied record was added for a website using a CNAME setup.', 'description' => 'A non-proxied record was added for a website using a CNAME setup.'], + ['errorCode' => 'Record.InvalidIodefDataWithCAARecordTag', 'errorMessage' => 'The CAA record Tag value cannot start with mailto: or http:// or https.', 'description' => 'When creating or editing CAA record information, the Tag value cannot start with mailto: http:// or 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' => 'The host record value cannot exist separately in various symbols, and can be added with any lowercase letters or numbers.'."\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 records cannot add all and asterisk prefixed records at the same time.'], + ['errorCode' => 'Record.InvalidHTTPURLValueWithCAARecordTag', 'errorMessage' => 'The CAA record is prefixed with http:// or https://, it must be followed by a valid URL.', 'description' => 'When you create or edit a CAA record, if the Tag is `iodef` and the Value starts with `http://` or `https://`, it must be followed by a valid URL.'], + ['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' => 'Illegal host record character. Only lowercase a-z, uppercase A- Z, digits 0-9, \'-\', \'_\', \'.\', \'*\', and \'@\' are supported as valid characters in host records \',\' @ \'.'."\n"], + ], + ], + '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\\": \\"The record name is invalid.\\",\\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"}]', + 'title' => 'Batch create DNS records', + 'description' => 'This API operation allows you to create or update multiple DNS records at a time. It is suitable for scenarios that require managing a large number of DNS configurations. Supported record types include but are not limited to A/AAAA, CNAME, NS, MX, TXT, CAA, SRV, and URI. Detailed configuration items are provided to meet specific requirements, such as Priority, Flag, Tag, and Weight. In addition, for specific record types such as CERT, SSHFP, SMIMEA, and TLSA, advanced settings such as certificate information and encryption algorithms are supported.'."\n" ."\n" - .'Records that succeeded or failed during the operation are listed separately in the response, enabling users to identify which records were processed successfully and which failed along with the reasons for failure. ', + .'Successfully and unsuccessfully processed records are listed separately in the response, so that you can identify which records are processed, which records failed, and the failure reasons.', 'changeSet' => [ - [ - 'createdAt' => '2025-06-10T08:19:05.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2025-02-18T05:59:13.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-11-12T05:57:29.000Z', - 'description' => 'Error codes changed, Request parameters changed', - ], - [ - 'createdAt' => '2024-10-11T06:13:39.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-24T08:28:18.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T06:13:42.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-06-10T08:19:05.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2025-02-18T05:59:13.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-11-12T05:57:29.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2024-10-11T06:13:39.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-24T08:28:18.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T06:13:42.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '1', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'BatchCreateRecords', - ], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchCreateRecords'], ], ], 'ramActions' => [ @@ -3967,27 +1869,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => 'Batch Create WAF Rules', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Batch creates rules in a specified WAF phase. You can create multiple rules at a time and configure shared settings for these rules.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -4000,90 +1891,65 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239658', - 'abilityTreeNodes' => [ - 'FEATUREdcdnBQ0J3E', - 'FEATUREdcdn1OLUH8', - ], + 'abilityTreeNodes' => ['FEATUREdcdnBQ0J3E', 'FEATUREdcdn1OLUH8'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'title' => '站点ID', - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Site version.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version on which the configuration takes effect. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'Phase', 'in' => 'formData', - 'schema' => [ - 'title' => 'WAF阶段', - 'description' => 'WAF rule type, with values:'."\n" - ."\n" - .'- **http_anti_scan**: Scan protection.'."\n" - .'- **http_bot**: Bots.', - 'type' => 'string', - 'required' => false, - 'example' => 'http_anti_scan', - ], + 'schema' => ['title' => '', 'description' => 'The WAF rule execution phase. This **batch operation supports only** the following two phases. For other phases, use the single-rule operations `CreateWafRule` or `UpdateWafRule`:'."\n" + .'- `http_anti_scan`: scan protection rules'."\n" + .'- `http_bot`: advanced mode bots'."\n" + ."\n" + .'> Note: The `http_anti_scan` and `http_bot` phases **support only batch creation**. The single-rule operation `CreateWafRule` does not accept these two values. Conversely, other phases such as `http_custom` and `http_whitelist` can be created only by using single-rule operations and cannot use this batch operation.'."\n" + ."\n" + .'**Required constraint**: Although this parameter is marked as optional (required: false) in the specification, it is **required** when you call this batch operation. If this parameter is not specified, the service returns `InvalidParameter(400)`.'."\n" + ."\n" + .'**Plan prerequisite**: `http_anti_scan` requires the site to have a **high or higher plan**. Calling this operation with a basic plan returns `Phase.HttpAntiScan.NotSupport`. Verify the site plan before calling this operation.', 'type' => 'string', 'example' => 'http_anti_scan', 'required' => false], ], [ 'name' => 'RulesetId', 'in' => 'formData', - 'schema' => [ - 'description' => 'Ruleset ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10000001', - 'minimum' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the WAF ruleset. You can call the [ListWafRulesets](~~2878359~~) operation to obtain the ruleset ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '1', 'example' => '10000001', 'title' => ''], ], [ 'name' => 'Shared', 'in' => 'formData', 'style' => 'json', - 'schema' => [ - 'title' => '多规则共享配置', - 'description' => 'Shared configuration for multiple rules, specifying common attributes of multiple rules.', - 'required' => false, - '$ref' => '#/components/schemas/WafBatchRuleShared', - 'example' => '', - ], + 'schema' => ['title' => '', 'description' => 'The shared configuration for multiple rules. Specifies the common properties of multiple rules.'."\n" + ."\n" + .'**Conditionally required**: Although this parameter is marked as optional (required: false) in the specification, it is **required** when `Phase=http_anti_scan`. If this parameter is not specified, the service returns `InvalidParameter(400)`.'."\n" + ."\n" + .'**Subfield requirements**: In the `http_anti_scan` phase, Shared must include shared fields such as `Name` (rule name) and `Action` (rule action). For other phases, the required subfields of Shared vary depending on the specific phase.', '$ref' => '#/components/schemas/WafBatchRuleShared', 'required' => false, 'example' => ''], ], [ 'name' => 'Configs', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '各规则配置列表', - 'description' => 'A list of configurations for each rule, specifying detailed configurations for each rule.', + 'title' => '', + 'description' => 'The list of rule configurations. Specifies the detailed configuration for each rule.'."\n" + ."\n" + .'**Required subfields for each phase** (applicable only to the two phases supported by this batch operation):'."\n" + ."\n" + .'- `http_anti_scan`: You must specify `Type` and at least one of `ManagedList` or `RateLimit`.'."\n" + .'- `http_bot`: You must specify the advanced mode bots configuration. The subfields are defined in the `WafRuleConfig` data structure.'."\n" + ."\n" + .'> Note: Other phases such as `http_custom` and `http_whitelist` cannot use this batch operation. Use the single-rule operation `CreateWafRule` instead. The subfield constraints are described in the single-rule operation documentation.'."\n" + ."\n" + .'> If `Configs` is not specified or required subfields are missing, the service returns `InvalidParameter(400)` or `Rule.Config.Malformed`.', 'type' => 'array', - 'items' => [ - 'description' => 'Rule configuration.', - 'required' => false, - '$ref' => '#/components/schemas/WafRuleConfig', - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'The rule configuration.', '$ref' => '#/components/schemas/WafRuleConfig', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, 'example' => '', ], @@ -4092,33 +1958,16 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], - 'RulesetId' => [ - 'description' => 'ID of the WAF ruleset, which can be obtained by calling the [ListWafRulesets](~~2878359~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000001', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], + 'RulesetId' => ['description' => 'The ID of the WAF ruleset. You can call the [ListWafRulesets](~~2878359~~) operation to obtain the ruleset ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000001', 'title' => ''], 'Ids' => [ - 'description' => 'ID of the WAF rule, which can be obtained by calling the [ListWafRules](~~2878257~~) interface.', + 'description' => 'The IDs of the WAF rules. You can call the [ListWafRules](~~2878257~~) operation to obtain the rule IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'ID of the WAF rule, which can be obtained by calling the [ListWafRules](~~2878257~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20000001', - 'title' => '', - ], + 'items' => ['description' => 'The IDs of the WAF rules. You can call the [ListWafRules](~~2878257~~) operation to obtain the rule IDs.', 'type' => 'integer', 'format' => 'int64', 'example' => '20000001', 'title' => ''], 'title' => '', 'example' => '', ], @@ -4129,93 +1978,32 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], ], 403 => [ - [ - 'errorCode' => '%s.NotSupport', - 'errorMessage' => 'The specified resource type %s is not supported.', - 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.', - ], - [ - 'errorCode' => '%s.OverQuota', - 'errorMessage' => 'The quantity of %s exceeds the quota.', - 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.', - ], - [ - 'errorCode' => '%s.WrongValueMatched', - 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', - 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.', - ], - [ - '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' => 'The format of the rule configuration is invalid.Check the configuration for syntax errors or structural inconsistencies and correct them to meet the requirements.', - ], - [ - 'errorCode' => 'Rule.Config.Noncompliance', - 'errorMessage' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', - 'description' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', - ], - [ - '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' => 'The specified rule set name already exists.Try again with a unique name or modify the existing rule set name.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'Expression.Invalid', - 'errorMessage' => 'The specified expression is invalid: %s.', - 'description' => 'The specified expression is invalid.', - ], - [ - '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' => '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.', - ], - ], - ], - 'title' => 'Batch Create WAF Rules', - 'changeSet' => [ - [ - 'createdAt' => '2025-04-17T07:08:14.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-09-25T07:02:52.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T06:13:38.000Z', - 'description' => 'Error codes changed', + ['errorCode' => '%s.NotSupport', 'errorMessage' => 'The specified resource type %s is not supported.', 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.'], + ['errorCode' => '%s.OverQuota', 'errorMessage' => 'The quantity of %s exceeds the quota.', 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.'], + ['errorCode' => '%s.WrongValueMatched', 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.'], + ['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' => 'The format of the rule configuration is invalid.Check the configuration for syntax errors or structural inconsistencies and correct them to meet the requirements.'], + ['errorCode' => 'Rule.Config.Noncompliance', 'errorMessage' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', 'description' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.'], + ['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' => 'The specified rule set name already exists.Try again with a unique name or modify the existing rule set name.'], + ['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' => '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.'], + ['errorCode' => 'Expression.Invalid', 'errorMessage' => 'The specified expression is invalid: %s.', 'description' => 'The specified expression is invalid.'], + ['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' => '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.'], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"RulesetId\\": 10000001,\\n \\"Ids\\": [\\n 20000001\\n ]\\n}","type":"json"}]', + 'title' => 'Batch create WAF rules', + 'changeSet' => [ + ['createdAt' => '2025-04-17T07:08:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-25T07:02:52.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T06:13:38.000Z', 'description' => 'Error codes changed'], + ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'BatchCreateWafRules', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchCreateWafRules'], ], ], 'ramActions' => [ @@ -4226,26 +2014,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => 'Deletes key-value pairs from a namespace at a time based on keys.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Delete key-value pairs in bulk from a specified namespace.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -4258,36 +2036,22 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239149', - 'abilityTreeNodes' => [ - 'FEATUREdcdnGMYWU5', - ], + 'abilityTreeNodes' => ['FEATUREdcdnGMYWU5'], ], 'parameters' => [ [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the namespace that you specify when you call the [CreateKvNamespace](~~2850317~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_namespace', - ], + 'schema' => ['description' => 'Name specified when you call [CreateKvNamespace](~~2850317~~).', 'type' => 'string', 'title' => '', 'required' => true, 'example' => 'test_namespace'], ], [ 'name' => 'Keys', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The keys that you want to delete. You can delete a maximum of 10,000 key-value pairs at a time.'."\n", + 'description' => 'List of keys to delete in bulk. You can delete up to 10,000 keys.', 'type' => 'array', - 'items' => [ - 'description' => 'The key that you want to delete.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_key1', - 'title' => '', - ], + 'items' => ['description' => 'Name of the key to delete.', 'type' => 'string', 'required' => false, 'example' => 'test_key1', 'title' => ''], 'required' => true, 'title' => '', 'example' => '', @@ -4298,36 +2062,21 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'ID of the request.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'], 'FailKeys' => [ - 'description' => 'The keys that failed to be deleted.'."\n", + 'description' => 'List of keys that failed to delete.', 'type' => 'array', - 'items' => [ - 'description' => 'The key that failed to be deleted.'."\n", - 'type' => 'string', - 'example' => 'test_key1', - 'title' => '', - ], + 'items' => ['description' => 'Name of a key that failed to delete.', 'type' => 'string', 'example' => 'test_key1', 'title' => ''], 'title' => '', 'example' => '', ], 'SuccessKeys' => [ - 'description' => 'The keys that are deleted.'."\n", + 'description' => 'List of keys that deleted successfully.', 'type' => 'array', - 'items' => [ - 'description' => 'The key that is deleted.'."\n", - 'type' => 'string', - 'example' => 'test_key2', - 'title' => '', - ], + 'items' => ['description' => 'Name of a key that deleted successfully.', 'type' => 'string', 'example' => 'test_key2', 'title' => ''], 'title' => '', 'example' => '', ], @@ -4338,115 +2087,44 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidAccount.Malformed', - 'errorMessage' => 'The specified account is invalid.', - 'description' => 'The account number is not entered correctly, for example, the input is empty.', - ], - [ - 'errorCode' => 'InvalidNameSpace.Malformed', - 'errorMessage' => 'The specified namespace is invalid.', - 'description' => 'The bucket name is entered incorrectly, such as an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.Malformed', - 'errorMessage' => 'The specified key is invalid.', - 'description' => 'Key name input error, such as entering an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.ExceedsMaximum', - 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', - 'description' => 'The length of the requested key is too large.', - ], - [ - 'errorCode' => 'InvalidValue.ExceedsMaximum', - 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', - 'description' => 'The value deposited is too large.', - ], + ['errorCode' => 'InvalidAccount.Malformed', 'errorMessage' => 'The specified account is invalid.', 'description' => 'The account number is not entered correctly, for example, the input is empty.'], + ['errorCode' => 'InvalidNameSpace.Malformed', 'errorMessage' => 'The specified namespace is invalid.', 'description' => 'The bucket name is entered incorrectly, such as an empty string.'], + ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified key is invalid.', 'description' => 'Key name input error, such as entering an empty string.'], + ['errorCode' => 'InvalidKey.ExceedsMaximum', 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', 'description' => 'The length of the requested key is too large.'], + ['errorCode' => 'InvalidValue.ExceedsMaximum', 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', 'description' => 'The value deposited is too large.'], ], 403 => [ - [ - 'errorCode' => 'InvalidKey.ExceedsCapacity', - 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', - 'description' => 'The capacity of the storage space exceeds the limit.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidParameters', - 'errorMessage' => 'The specified authentication parameters are invalid.', - 'description' => 'Authentication parameter input error.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'InvalidKey.ExceedsCapacity', 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', 'description' => 'The capacity of the storage space exceeds the limit.'], + ['errorCode' => 'Unauthorized.InvalidParameters', 'errorMessage' => 'The specified authentication parameters are invalid.', 'description' => 'Authentication parameter input error.'], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'InvalidAccount.NotFound', - 'errorMessage' => 'The specified account does not exist.', - 'description' => 'The specified account does not exist.', - ], - [ - 'errorCode' => 'InvalidNameSpace.NotFound', - 'errorMessage' => 'The specified namespace does not exist.', - 'description' => '', - ], - [ - 'errorCode' => 'InvalidKey.NotFound', - 'errorMessage' => 'The specified key does not exist.', - 'description' => 'The specified key-value pair does not exist.', - ], + ['errorCode' => 'InvalidAccount.NotFound', 'errorMessage' => 'The specified account does not exist.', 'description' => 'The specified account does not exist.'], + ['errorCode' => 'InvalidNameSpace.NotFound', 'errorMessage' => 'The specified namespace does not exist.', 'description' => ''], + ['errorCode' => 'InvalidKey.NotFound', 'errorMessage' => 'The specified key does not exist.', 'description' => 'The specified key-value pair does not exist.'], ], 406 => [ - [ - 'errorCode' => 'InvalidNameSpace.Duplicate', - 'errorMessage' => 'The specified namespace already exists.', - 'description' => 'Specified storage space', - ], - [ - 'errorCode' => 'InvalidNameSpace.QuotaFull', - 'errorMessage' => 'The maximum number of namespaces is exceeded.', - 'description' => 'The number of storage spaces exceeds the capacity limit.', - ], + ['errorCode' => 'InvalidNameSpace.Duplicate', 'errorMessage' => 'The specified namespace already exists.', 'description' => 'Specified storage space'], + ['errorCode' => 'InvalidNameSpace.QuotaFull', 'errorMessage' => 'The maximum number of namespaces is exceeded.', 'description' => 'The number of storage spaces exceeds the capacity limit.'], ], 429 => [ - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests are submitted.', - 'description' => 'Submissions are too frequent, please try again later', - ], - [ - 'errorCode' => 'TooQuickRequests', - 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', - 'description' => 'The modification or deletion of key-value pairs is too frequent.', - ], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests are submitted.', 'description' => 'Submissions are too frequent, please try again later'], + ['errorCode' => 'TooQuickRequests', 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', 'description' => 'The modification or deletion of key-value pairs is too frequent.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - '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"}]', 'title' => 'BatchDeleteKv', 'changeSet' => [ - [ - 'createdAt' => '2024-09-20T13:49:27.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-20T13:49:27.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '1', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'BatchDeleteKv', - ], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchDeleteKv'], ], ], 'ramActions' => [ @@ -4457,29 +2135,17 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], + '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' => [ - 'summary' => 'Deletes multiple key-value pairs from a namespace at a time based on specified keys. The request body can be up to 100 MB.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Batch deletes key-value pairs from a specified KV namespace based on a specified list of key names. The maximum request body size is 100 MB.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -4492,69 +2158,43 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239122', - 'abilityTreeNodes' => [ - 'FEATUREdcdnGMYWU5', - ], + 'abilityTreeNodes' => ['FEATUREdcdnGMYWU5'], ], 'parameters' => [ [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the namespace that you specify when you call the [CreateKvNamespace](~~2850317~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_namespace', - ], + 'schema' => ['description' => 'The namespace name specified when you called [CreateKvNamespace](~~2850317~~).', 'type' => 'string', 'title' => '', 'required' => true, 'example' => 'test_namespace'], ], [ 'name' => 'Url', 'in' => 'query', - 'schema' => [ - 'description' => 'The download URL of the key-value pairs that you want to delete. This parameter is automatically filled in when you use the SDK to call the operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7', - 'isFileTransferUrl' => true, - 'title' => '', - ], + 'schema' => ['description' => 'The download URL that contains the key-value pairs to be batch deleted, such as an OSS download URL with read permissions.'."\n" + ."\n" + .'- When you call this operation by using the SDK, the SDK automatically uploads the content to OSS and passes the corresponding URL.'."\n" + ."\n" + .'- To call this operation directly, upload the JSON payload (in the same format as the BatchDeleteKv body: {"Namespace":"...","Keys":[...]}) to an OSS bucket and generate a signed HTTPS GET URL.', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'https://xxxobject.oss-cn-region.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'], 'FailKeys' => [ - 'description' => 'The keys that failed to be deleted.'."\n", + 'description' => 'The list of keys that failed to be deleted.', 'type' => 'array', - 'items' => [ - 'description' => 'The key that failed to be deleted.'."\n", - 'type' => 'string', - 'example' => 'test_key1', - 'title' => '', - ], + 'items' => ['description' => 'The key name that failed to be deleted.', 'type' => 'string', 'example' => 'test_key1', 'title' => ''], 'title' => '', 'example' => '', ], 'SuccessKeys' => [ - 'description' => 'The keys that are deleted.'."\n", + 'description' => 'The list of keys that were successfully deleted.', 'type' => 'array', - 'items' => [ - 'description' => 'The key that is deleted.'."\n", - 'type' => 'string', - 'example' => 'test_key1', - 'title' => '', - ], + 'items' => ['description' => 'The key name that was successfully deleted.', 'type' => 'string', 'example' => 'test_key1', 'title' => ''], 'title' => '', 'example' => '', ], @@ -4565,186 +2205,94 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidAccount.Malformed', - 'errorMessage' => 'The specified account is invalid.', - 'description' => 'The account number is not entered correctly, for example, the input is empty.', - ], - [ - 'errorCode' => 'InvalidNameSpace.Malformed', - 'errorMessage' => 'The specified namespace is invalid.', - 'description' => 'The bucket name is entered incorrectly, such as an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.Malformed', - 'errorMessage' => 'The specified key is invalid.', - 'description' => 'Key name input error, such as entering an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.ExceedsMaximum', - 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', - 'description' => 'The length of the requested key is too large.', - ], - [ - 'errorCode' => 'InvalidValue.ExceedsMaximum', - 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', - 'description' => 'The value deposited is too large.', - ], + ['errorCode' => 'InvalidAccount.Malformed', 'errorMessage' => 'The specified account is invalid.', 'description' => 'The account number is not entered correctly, for example, the input is empty.'], + ['errorCode' => 'InvalidNameSpace.Malformed', 'errorMessage' => 'The specified namespace is invalid.', 'description' => 'The bucket name is entered incorrectly, such as an empty string.'], + ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified key is invalid.', 'description' => 'Key name input error, such as entering an empty string.'], + ['errorCode' => 'InvalidKey.ExceedsMaximum', 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', 'description' => 'The length of the requested key is too large.'], + ['errorCode' => 'InvalidValue.ExceedsMaximum', 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', 'description' => 'The value deposited is too large.'], ], 403 => [ - [ - 'errorCode' => 'InvalidKey.ExceedsCapacity', - 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', - 'description' => 'The capacity of the storage space exceeds the limit.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidParameters', - 'errorMessage' => 'The specified authentication parameters are invalid.', - 'description' => 'Authentication parameter input error.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'InvalidKey.ExceedsCapacity', 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', 'description' => 'The capacity of the storage space exceeds the limit.'], + ['errorCode' => 'Unauthorized.InvalidParameters', 'errorMessage' => 'The specified authentication parameters are invalid.', 'description' => 'Authentication parameter input error.'], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'InvalidAccount.NotFound', - 'errorMessage' => 'The specified account does not exist.', - 'description' => 'The specified account does not exist.', - ], - [ - 'errorCode' => 'InvalidNameSpace.NotFound', - 'errorMessage' => 'The specified namespace does not exist.', - 'description' => '', - ], - [ - 'errorCode' => 'InvalidKey.NotFound', - 'errorMessage' => 'The specified key does not exist.', - 'description' => 'The specified key-value pair does not exist.', - ], + ['errorCode' => 'InvalidAccount.NotFound', 'errorMessage' => 'The specified account does not exist.', 'description' => 'The specified account does not exist.'], + ['errorCode' => 'InvalidNameSpace.NotFound', 'errorMessage' => 'The specified namespace does not exist.', 'description' => ''], + ['errorCode' => 'InvalidKey.NotFound', 'errorMessage' => 'The specified key does not exist.', 'description' => 'The specified key-value pair does not exist.'], ], 406 => [ - [ - 'errorCode' => 'InvalidNameSpace.Duplicate', - 'errorMessage' => 'The specified namespace already exists.', - 'description' => 'Specified storage space', - ], - [ - 'errorCode' => 'InvalidNameSpace.QuotaFull', - 'errorMessage' => 'The maximum number of namespaces is exceeded.', - 'description' => 'The number of storage spaces exceeds the capacity limit.', - ], + ['errorCode' => 'InvalidNameSpace.Duplicate', 'errorMessage' => 'The specified namespace already exists.', 'description' => 'Specified storage space'], + ['errorCode' => 'InvalidNameSpace.QuotaFull', 'errorMessage' => 'The maximum number of namespaces is exceeded.', 'description' => 'The number of storage spaces exceeds the capacity limit.'], ], 429 => [ - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests are submitted.', - 'description' => 'Submissions are too frequent, please try again later', - ], - [ - 'errorCode' => 'TooQuickRequests', - 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', - 'description' => 'The modification or deletion of key-value pairs is too frequent.', - ], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests are submitted.', 'description' => 'Submissions are too frequent, please try again later'], + ['errorCode' => 'TooQuickRequests', 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', 'description' => 'The modification or deletion of key-value pairs is too frequent.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], '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"}]', - 'title' => 'BatchDeleteKvWithHighCapacity', - 'description' => 'This operation allows you to upload a larger request body than by using [BatchDeleteKv](~~2850204~~). For small request bodies, we recommend that you use [BatchDeleteKv](~~2850204~~) to minimize the server processing time. This operation must be called by using SDKs. The following sample code uses the Golang SDK and BatchDeleteKvWithHighCapacityAdvance to call the operation.'."\n" + 'title' => 'Batch delete high-capacity key-value pairs from a KV namespace', + 'description' => '>'."\n" + .'Prerequisites for non-SDK calls: (1) You must have an OSS bucket with read and write permissions. (2) You must be able to generate a pre-signed HTTPS GET URL by using the OSS SDK or API. (3) The uploaded JSON file must use the same format as the BatchDeleteKv request body.>.'."\n" ."\n" - .' func TestBatchDeleteWithHighCapacity() error {'."\n" - .' // Initialize the configurations.'."\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" + .'This operation provides the same functionality as [BatchDeleteKv](~~2850204~~), but allows a larger request body. If the request body is small, use the [BatchDeleteKv](~~2850204~~) operation to reduce server-side processing time. This operation must be called by using an SDK. For example, when using the Golang SDK, call the BatchDeleteKvWithHighCapacityAdvance function.'."\n" + .'```'."\n" + .'func TestBatchDeleteWithHighCapacity() error {'."\n" + .' // Initialize the configuration'."\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" - .' // Construct a request for deleting key-value pairs at a time.'."\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" + .' // Construct the batch delete request for key-value pairs'."\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" - .' // If the payload is greater than 2 MB, call the BatchDeleteKvWithHighCapacity operation for deletion.'."\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" - .' }'."\n", + .' // If the payload is larger than 2 MB, call the high-capacity operation to delete the key-value pairs'."\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' => 'Error codes changed', - ], + ['createdAt' => '2024-09-20T13:49:26.000Z', 'description' => 'Error codes changed'], ], '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchDeleteKvWithHighCapacity'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], + 'ramActions' => [], ], 'BatchGetExpressionFields' => [ - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Retrieves matching items for expressions in batches.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -4757,90 +2305,47 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239608', - 'abilityTreeNodes' => [ - 'FEATUREdcdnWQK30N', - ], + 'abilityTreeNodes' => ['FEATUREdcdnWQK30N'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'title' => '站点ID', - 'description' => 'Site ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The plan instance ID.', 'type' => 'string', 'required' => false, 'example' => 'esa-site-bitkull7uubk', 'title' => ''], ], [ 'name' => 'PlanNameEn', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The plan name (in English).', 'type' => 'string', 'required' => false, 'example' => 'entranceplan', 'title' => ''], ], [ 'name' => 'Kind', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The type of the expression.', 'type' => 'string', 'required' => false, 'example' => 'wireshark', 'title' => ''], ], [ 'name' => 'Phase', 'in' => 'formData', - 'schema' => [ - 'title' => 'WAF阶段', - 'description' => 'WAF Phase', - 'type' => 'string', - 'required' => false, - 'example' => 'http_bot', - ], + 'schema' => ['title' => '', 'description' => 'The WAF phase.', 'type' => 'string', 'example' => 'http_bot', 'required' => false], ], [ 'name' => 'Expressions', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'List of expressions.', + 'description' => 'The list of expressions.', 'type' => 'array', 'items' => [ - 'description' => 'Details of the expression.', + 'description' => 'The details of the expression.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The sequence number of the expression.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'title' => '', - ], - 'Expression' => [ - 'description' => 'Content of the expression.', - 'type' => 'string', - 'required' => false, - 'example' => 'ip.src eq 1.1.1.1', - 'title' => '', - ], + 'Id' => ['description' => 'The sequence number of the expression.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'Expression' => ['description' => 'The content of the expression.', 'type' => 'string', 'required' => false, 'example' => 'ip.src eq 1.1.1.1', 'title' => ''], ], 'required' => false, 'title' => '', @@ -4855,38 +2360,23 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], 'Fields' => [ - 'description' => 'List of match fields.', + 'description' => 'The list of matching fields.', 'type' => 'array', 'items' => [ - 'description' => 'Details of match fields.', + 'description' => 'The details of the matching field.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'ID of the expression, corresponding to the ID in the input parameters.', - 'type' => 'string', - 'example' => '1', - 'title' => '', - ], + 'Id' => ['description' => 'The ID of the expression, which corresponds to the ID in the request parameters.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Fields' => [ - 'description' => 'List of match fields for a single expression.', + 'description' => 'The list of matching fields for a single expression.', 'type' => 'array', - 'items' => [ - 'description' => 'Value of a single match field for an expression.', - 'type' => 'string', - 'example' => 'ip.src', - 'title' => '', - ], + 'items' => ['description' => 'The matching field value for a single expression.', 'type' => 'string', 'example' => 'ip.src', 'title' => ''], 'title' => '', 'example' => '', ], @@ -4904,52 +2394,27 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], 403 => [ - [ - 'errorCode' => 'Expression.Invalid', - 'errorMessage' => 'Expression syntax error or data type mismatched.', - 'description' => 'Expression syntax error or data type mismatched.', - ], + ['errorCode' => 'Expression.Invalid', 'errorMessage' => 'Expression syntax error or data type mismatched.', 'description' => 'Expression syntax error or data type mismatched.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'title' => 'Batch Get Expression Match Fields', - 'summary' => 'Batch Get Expression Matches', + '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"}]', + 'title' => 'Batch retrieve matching fields for expressions', 'changeSet' => [ - [ - 'createdAt' => '2024-09-25T07:02:48.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T06:13:41.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-25T07:02:48.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T06:13:41.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'BatchGetExpressionFields', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchGetExpressionFields'], ], ], 'ramActions' => [ @@ -4960,25 +2425,15 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -4991,62 +2446,28 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239368', - 'abilityTreeNodes' => [ - 'FEATUREdcdnGMYWU5', - ], + 'abilityTreeNodes' => ['FEATUREdcdnGMYWU5'], ], 'parameters' => [ [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the namespace that you specify when you call the [CreateKvNamespace](~~2850317~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_namespace', - ], + 'schema' => ['description' => 'The name specified when you call [CreateKvNamespace](~~2850317~~).', 'type' => 'string', 'title' => '', 'required' => true, 'example' => 'test_namespace'], ], [ 'name' => 'KvList', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The key-value pairs that you want to configure at a time. The total size can be up to 2 MB (2 × 1000 × 1000).'."\n", + 'description' => 'The list of key-value pairs to set. The total size cannot exceed 2 MB (2 × 1,000 × 1,000).', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The key name. The name can be up to 512 characters in length and cannot contain spaces or backslashes (\\\\).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_key', - 'title' => '', - ], - 'Value' => [ - 'description' => 'The key content.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_value', - 'title' => '', - ], - 'Expiration' => [ - 'description' => 'The time when the key-value pair expires, which cannot be earlier than the current time. The value is a timestamp in seconds. If you specify both Expiration and ExpirationTtl, only ExpirationTtl takes effect.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1690081381', - 'title' => '', - ], - 'ExpirationTtl' => [ - 'description' => 'The relative expiration time. Unit: seconds. If you specify both Expiration and ExpirationTtl, only ExpirationTtl takes effect.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3600', - 'title' => '', - ], + 'Key' => ['description' => 'The name of the key. The key can be up to 512 characters long and cannot contain spaces or backslashes (/).', 'type' => 'string', 'required' => true, 'example' => 'test_key', 'title' => ''], + 'Value' => ['description' => 'The value of the key.', 'type' => 'string', 'required' => true, 'example' => 'test_value', 'title' => ''], + 'Expiration' => ['description' => 'The expiration time. This is a UNIX timestamp in seconds and cannot be earlier than the current time. If you set both Expiration and ExpirationTtl, ExpirationTtl takes precedence.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1690081381', 'title' => ''], + 'ExpirationTtl' => ['description' => 'The time-to-live (TTL). This is a relative time in seconds. If you set both Expiration and ExpirationTtl, ExpirationTtl takes precedence.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3600', 'title' => ''], ], 'required' => true, 'description' => '', @@ -5063,36 +2484,21 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'], 'FailKeys' => [ - 'description' => 'The keys that failed to be written.'."\n", + 'description' => 'A list of keys that failed to be written.', 'type' => 'array', - 'items' => [ - 'description' => 'The name of the key that failed to be written.'."\n", - 'type' => 'string', - 'example' => 'test_key1', - 'title' => '', - ], + 'items' => ['description' => 'The name of a key that failed to be written.', 'type' => 'string', 'example' => 'test_key1', 'title' => ''], 'title' => '', 'example' => '', ], 'SuccessKeys' => [ - 'description' => 'The keys that were written.'."\n", + 'description' => 'A list of keys that were successfully written.', 'type' => 'array', - 'items' => [ - 'description' => 'The name of the key that was written.'."\n", - 'type' => 'string', - 'example' => 'test_key2', - 'title' => '', - ], + 'items' => ['description' => 'The name of a key that was successfully written.', 'type' => 'string', 'example' => 'test_key2', 'title' => ''], 'title' => '', 'example' => '', ], @@ -5103,119 +2509,45 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidAccount.Malformed', - 'errorMessage' => 'The specified account is invalid.', - 'description' => 'The account number is not entered correctly, for example, the input is empty.', - ], - [ - 'errorCode' => 'InvalidNameSpace.Malformed', - 'errorMessage' => 'The specified namespace is invalid.', - 'description' => 'The bucket name is entered incorrectly, such as an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.Malformed', - 'errorMessage' => 'The specified key is invalid.', - 'description' => 'Key name input error, such as entering an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.ExceedsMaximum', - 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', - 'description' => 'The length of the requested key is too large.', - ], - [ - 'errorCode' => 'InvalidValue.ExceedsMaximum', - 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', - 'description' => 'The value deposited is too large.', - ], + ['errorCode' => 'InvalidAccount.Malformed', 'errorMessage' => 'The specified account is invalid.', 'description' => 'The account number is not entered correctly, for example, the input is empty.'], + ['errorCode' => 'InvalidNameSpace.Malformed', 'errorMessage' => 'The specified namespace is invalid.', 'description' => 'The bucket name is entered incorrectly, such as an empty string.'], + ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified key is invalid.', 'description' => 'Key name input error, such as entering an empty string.'], + ['errorCode' => 'InvalidKey.ExceedsMaximum', 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', 'description' => 'The length of the requested key is too large.'], + ['errorCode' => 'InvalidValue.ExceedsMaximum', 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', 'description' => 'The value deposited is too large.'], ], 403 => [ - [ - 'errorCode' => 'InvalidKey.ExceedsCapacity', - 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', - 'description' => 'The capacity of the storage space exceeds the limit.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidParameters', - 'errorMessage' => 'The specified authentication parameters are invalid.', - 'description' => 'Authentication parameter input error.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'InvalidKey.ExceedsCapacity', 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', 'description' => 'The capacity of the storage space exceeds the limit.'], + ['errorCode' => 'Unauthorized.InvalidParameters', 'errorMessage' => 'The specified authentication parameters are invalid.', 'description' => 'Authentication parameter input error.'], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'InvalidAccount.NotFound', - 'errorMessage' => 'The specified account does not exist.', - 'description' => 'The specified account does not exist.', - ], - [ - 'errorCode' => 'InvalidNameSpace.NotFound', - 'errorMessage' => 'The specified namespace does not exist.', - 'description' => '', - ], - [ - 'errorCode' => 'InvalidKey.NotFound', - 'errorMessage' => 'The specified key does not exist.', - 'description' => 'The specified key-value pair does not exist.', - ], + ['errorCode' => 'InvalidAccount.NotFound', 'errorMessage' => 'The specified account does not exist.', 'description' => 'The specified account does not exist.'], + ['errorCode' => 'InvalidNameSpace.NotFound', 'errorMessage' => 'The specified namespace does not exist.', 'description' => ''], + ['errorCode' => 'InvalidKey.NotFound', 'errorMessage' => 'The specified key does not exist.', 'description' => 'The specified key-value pair does not exist.'], ], 406 => [ - [ - 'errorCode' => 'InvalidNameSpace.Duplicate', - 'errorMessage' => 'The specified namespace already exists.', - 'description' => 'Specified storage space', - ], - [ - 'errorCode' => 'InvalidNameSpace.QuotaFull', - 'errorMessage' => 'The maximum number of namespaces is exceeded.', - 'description' => 'The number of storage spaces exceeds the capacity limit.', - ], + ['errorCode' => 'InvalidNameSpace.Duplicate', 'errorMessage' => 'The specified namespace already exists.', 'description' => 'Specified storage space'], + ['errorCode' => 'InvalidNameSpace.QuotaFull', 'errorMessage' => 'The maximum number of namespaces is exceeded.', 'description' => 'The number of storage spaces exceeds the capacity limit.'], ], 429 => [ - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests are submitted.', - 'description' => 'Submissions are too frequent, please try again later', - ], - [ - 'errorCode' => 'TooQuickRequests', - 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', - 'description' => 'The modification or deletion of key-value pairs is too frequent.', - ], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests are submitted.', 'description' => 'Submissions are too frequent, please try again later'], + ['errorCode' => 'TooQuickRequests', 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', 'description' => 'The modification or deletion of key-value pairs is too frequent.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'BatchPutKv', - 'summary' => 'Configures key-value pairs for a namespace at a time based on specified keys.', + 'summary' => 'Sets multiple key-value pairs in a specified namespace.', 'changeSet' => [ - [ - 'createdAt' => '2024-09-20T13:49:26.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-20T13:49:26.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '1', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'BatchPutKv', - ], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchPutKv'], ], ], 'ramActions' => [ @@ -5226,12 +2558,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -5239,13 +2566,9 @@ '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' => 'Configures key-value pairs for a namespace at a time based on specified keys. The request body can be up to 100 MB.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Batch sets key-value pairs in a specified KV namespace based on a specified list of key names. The maximum request body size is 100 MB.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5258,69 +2581,45 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239294', - 'abilityTreeNodes' => [ - 'FEATUREdcdnGMYWU5', - ], + 'abilityTreeNodes' => ['FEATUREdcdnGMYWU5'], ], 'parameters' => [ [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the namespace that you specify when you call the [CreateKvNamespace](~~2850317~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_namespace', - ], + 'schema' => ['description' => 'The namespace name specified when you called [CreateKvNamespace](~~2850317~~).', 'type' => 'string', 'title' => '', 'required' => true, 'example' => 'test_namespace'], ], [ 'name' => 'Url', 'in' => 'query', - 'schema' => [ - 'description' => 'The download URL of the key-value pairs that you want to configure. This parameter is automatically filled in when you use the SDK to call the operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7', - 'isFileTransferUrl' => true, - 'title' => '', - ], + 'schema' => ['description' => 'A publicly accessible HTTP(S) URL that points to a JSON file containing the key-value pairs to be batch set. The server actively downloads the content from this URL.'."\n" + ."\n" + .'- If you use an SDK, the SDK automatically uploads the file and generates the URL.'."\n" + ."\n" + .'- In non-SDK scenarios, upload the JSON payload to any publicly accessible HTTP service and specify the URL.'."\n" + ."\n" + .'The file content pointed to by the URL must be in the following JSON format: {"Namespace":"","KvList":[{"Key":"","Value":""},...]}.If the URL content does not match this format, the API silently returns an empty SuccessKeys array.', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'https://xxxobject.oss-cn-region.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'], 'FailKeys' => [ - 'description' => 'The keys that failed to be written.'."\n", + 'description' => 'The list of keys that failed to be written.', 'type' => 'array', - 'items' => [ - 'description' => 'The name of the key that failed to be written.'."\n", - 'type' => 'string', - 'example' => 'test_key1', - 'title' => '', - ], + 'items' => ['description' => 'The key name that failed to be written.', 'type' => 'string', 'example' => 'test_key1', 'title' => ''], 'title' => '', 'example' => '', ], 'SuccessKeys' => [ - 'description' => 'The keys that were written.'."\n", + 'description' => 'The list of keys that were written.', 'type' => 'array', - 'items' => [ - 'description' => 'The name of the key that was written.'."\n", - 'type' => 'string', - 'example' => 'test_key2', - 'title' => '', - ], + 'items' => ['description' => 'The key name that was written.', 'type' => 'string', 'example' => 'test_key2', 'title' => ''], 'title' => '', 'example' => '', ], @@ -5331,196 +2630,100 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidAccount.Malformed', - 'errorMessage' => 'The specified account is invalid.', - 'description' => 'The account number is not entered correctly, for example, the input is empty.', - ], - [ - 'errorCode' => 'InvalidNameSpace.Malformed', - 'errorMessage' => 'The specified namespace is invalid.', - 'description' => 'The bucket name is entered incorrectly, such as an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.Malformed', - 'errorMessage' => 'The specified key is invalid.', - 'description' => 'Key name input error, such as entering an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.ExceedsMaximum', - 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', - 'description' => 'The length of the requested key is too large.', - ], - [ - 'errorCode' => 'InvalidValue.ExceedsMaximum', - 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', - 'description' => 'The value deposited is too large.', - ], + ['errorCode' => 'InvalidAccount.Malformed', 'errorMessage' => 'The specified account is invalid.', 'description' => 'The account number is not entered correctly, for example, the input is empty.'], + ['errorCode' => 'InvalidNameSpace.Malformed', 'errorMessage' => 'The specified namespace is invalid.', 'description' => 'The bucket name is entered incorrectly, such as an empty string.'], + ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified key is invalid.', 'description' => 'Key name input error, such as entering an empty string.'], + ['errorCode' => 'InvalidKey.ExceedsMaximum', 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', 'description' => 'The length of the requested key is too large.'], + ['errorCode' => 'InvalidValue.ExceedsMaximum', 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', 'description' => 'The value deposited is too large.'], ], 403 => [ - [ - 'errorCode' => 'InvalidKey.ExceedsCapacity', - 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', - 'description' => 'The capacity of the storage space exceeds the limit.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidParameters', - 'errorMessage' => 'The specified authentication parameters are invalid.', - 'description' => 'Authentication parameter input error.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'InvalidKey.ExceedsCapacity', 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', 'description' => 'The capacity of the storage space exceeds the limit.'], + ['errorCode' => 'Unauthorized.InvalidParameters', 'errorMessage' => 'The specified authentication parameters are invalid.', 'description' => 'Authentication parameter input error.'], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'InvalidAccount.NotFound', - 'errorMessage' => 'The specified account does not exist.', - 'description' => 'The specified account does not exist.', - ], - [ - 'errorCode' => 'InvalidNameSpace.NotFound', - 'errorMessage' => 'The specified namespace does not exist.', - 'description' => '', - ], - [ - 'errorCode' => 'InvalidKey.NotFound', - 'errorMessage' => 'The specified key does not exist.', - 'description' => 'The specified key-value pair does not exist.', - ], + ['errorCode' => 'InvalidAccount.NotFound', 'errorMessage' => 'The specified account does not exist.', 'description' => 'The specified account does not exist.'], + ['errorCode' => 'InvalidNameSpace.NotFound', 'errorMessage' => 'The specified namespace does not exist.', 'description' => ''], + ['errorCode' => 'InvalidKey.NotFound', 'errorMessage' => 'The specified key does not exist.', 'description' => 'The specified key-value pair does not exist.'], ], 406 => [ - [ - 'errorCode' => 'InvalidNameSpace.Duplicate', - 'errorMessage' => 'The specified namespace already exists.', - 'description' => 'Specified storage space', - ], - [ - 'errorCode' => 'InvalidNameSpace.QuotaFull', - 'errorMessage' => 'The maximum number of namespaces is exceeded.', - 'description' => 'The number of storage spaces exceeds the capacity limit.', - ], + ['errorCode' => 'InvalidNameSpace.Duplicate', 'errorMessage' => 'The specified namespace already exists.', 'description' => 'Specified storage space'], + ['errorCode' => 'InvalidNameSpace.QuotaFull', 'errorMessage' => 'The maximum number of namespaces is exceeded.', 'description' => 'The number of storage spaces exceeds the capacity limit.'], ], 429 => [ - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests are submitted.', - 'description' => 'Submissions are too frequent, please try again later', - ], - [ - 'errorCode' => 'TooQuickRequests', - 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', - 'description' => 'The modification or deletion of key-value pairs is too frequent.', - ], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests are submitted.', 'description' => 'Submissions are too frequent, please try again later'], + ['errorCode' => 'TooQuickRequests', 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', 'description' => 'The modification or deletion of key-value pairs is too frequent.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], '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"}]', - 'title' => 'BatchPutKvWithHighCapacity', - 'description' => 'This operation allows you to upload a larger request body than by using [BatchPutKv](~~2850203~~). For small request bodies, we recommend that you use [BatchPutKv](~~2850203~~) to minimize the server processing time. This operation must be called by using SDKs. The following sample code uses the Golang SDK and BatchPutKvWithHighCapacityAdvance to call the operation.'."\n" + 'title' => 'Batch set large-capacity key-value pairs in a KV namespace', + 'description' => 'This operation provides the same functionality as [BatchPutKv](~~2850203~~), but allows larger request bodies. If the request body is small, use the [BatchPutKv](~~2850203~~) operation to reduce server-side processing time. This operation must be called by using an SDK. For example, when using the Golang SDK, call the BatchPutKvWithHighCapacityAdvance function.'."\n" + .'```'."\n" + .'func TestBatchPutKvWithHighCapacity() error {'."\n" + .' // Initialize the configuration'."\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" - .' func TestBatchPutKvWithHighCapacity() error {'."\n" - .' // Initialize the configurations.'."\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" + .' // Construct the key-value pairs for batch upload'."\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" - .' // Construct a request for uploading key-value pairs at a time.'."\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" + .' payload, err := json.Marshal(rawReq)'."\n" + .' if err != nil {'."\n" + .' return err'."\n" + .' }.'."\n" ."\n" - .' payload, err := json.Marshal(rawReq)'."\n" - .' if err != nil {'."\n" - .' return err'."\n" - .' }'."\n" - ."\n" - .' // If the payload is greater than 2 MB, call the BatchPutKvWithHighCapacity operation for upload.'."\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" - .' }'."\n", + .' // If the payload is larger than 2 MB, call the high-capacity operation to upload it'."\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' => 'Error codes changed', - ], + ['createdAt' => '2024-09-20T13:49:26.000Z', 'description' => 'Error codes changed'], ], '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchPutKvWithHighCapacity'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], + 'ramActions' => [], ], 'BatchUpdateWafRules' => [ - 'summary' => 'Modifies multiple rules in a specific Web Application Firewall (WAF) ruleset at a time.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Batch updates rules in a specified WAF ruleset. You can use this operation to update the configurations of multiple rules at a time.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5533,70 +2736,44 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239643', - 'abilityTreeNodes' => [ - 'FEATUREdcdnBQ0J3E', - 'FEATUREdcdn1OLUH8', - ], + 'abilityTreeNodes' => ['FEATUREdcdnBQ0J3E', 'FEATUREdcdn1OLUH8'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The version of the website.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version on which the configuration takes effect. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'Phase', 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => 'The WAF rule category.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http_anti_scan', - ], + 'schema' => ['title' => '', 'description' => 'The WAF rule execution phase. This **batch operation supports only** the following two phases. For other phases, use the single-rule operation `UpdateWafRule`:'."\n" + .'- `http_anti_scan`: scan protection rules'."\n" + .'- `http_bot`: advanced mode bots'."\n" + ."\n" + .'> Note: The `http_anti_scan` and `http_bot` phases **support only batch updates**. The single-rule operation `UpdateWafRule` does not accept these two values. Conversely, other phases such as `http_custom` and `http_whitelist` can be updated only by using the single-rule operation, not this batch operation.'."\n" + ."\n" + .'**Required constraint**: Although this parameter is marked as optional (required: false) in the specification, it is **required** when you call this batch operation. The server cannot determine the target ruleset without the Phase parameter and returns `InvalidParameter(400)` if it is not provided.', 'type' => 'string', 'example' => 'http_anti_scan', 'required' => false], ], [ 'name' => 'RulesetId', 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => 'The ID of the WAF ruleset, which can be obtained by calling the [ListWafRulesets](~~2878359~~) operation.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10000001', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the WAF ruleset. You can call the [ListWafRulesets](~~2878359~~) operation to obtain the ruleset ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000001', 'required' => false], ], [ 'name' => 'Shared', 'in' => 'formData', 'style' => 'json', - 'schema' => [ - 'title' => '', - 'description' => 'The configurations shared by multiple rules.'."\n", - 'required' => false, - 'example' => '10000001', - '$ref' => '#/components/schemas/WafBatchRuleShared', - ], + 'schema' => ['title' => '', 'description' => 'The shared configuration for multiple rules. Specifies the common properties shared across multiple rules.'."\n" + ."\n" + .'**Conditionally required**: Although this parameter is marked as optional (required: false) in the specification, it is **required** when `Phase=http_anti_scan`. The server returns `InvalidParameter(400)` if it is not provided.'."\n" + ."\n" + .'**Subfield requirements**: When the phase is `http_anti_scan`, Shared must include the `Name` (rule name), `Expression` (match expression), and `Action` (rule action) shared fields. For other phases, the required subfields of Shared vary depending on the specific phase.', '$ref' => '#/components/schemas/WafBatchRuleShared', 'required' => false, 'example' => ''], ], [ 'name' => 'Configs', @@ -5604,33 +2781,31 @@ 'style' => 'json', 'schema' => [ 'title' => '', - 'description' => 'The configurations of rules.'."\n", + 'description' => 'The list of rule configurations. Specifies the detailed configuration for each rule.'."\n" + ."\n" + .'**Required subfields for each phase** (applicable only to the two phases supported by this batch operation):'."\n" + ."\n" + .'- `http_anti_scan`: You must provide `Type` and at least one of `ManagedList` or `RateLimit`.'."\n" + .'- `http_bot`: You must provide the advanced mode bots configuration. The subfields are defined in the `WafRuleConfig` data structure.'."\n" + ."\n" + .'> Note: Other phases such as `http_custom` and `http_whitelist` cannot use this batch operation. Use the single-rule operation `UpdateWafRule` instead. The subfield constraints for those phases are described in the single-rule operation documentation.'."\n" + ."\n" + .'> Important: If `Configs` is missing or subfields are incomplete, the server returns `InvalidParameter(400)` or `Rule.Config.Malformed`.', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'The configuration of the rule.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/WafRuleConfig', - 'example' => '', - ], + 'items' => ['title' => '', 'description' => 'The rule configuration.', '$ref' => '#/components/schemas/WafRuleConfig', 'required' => false, 'example' => ''], 'required' => false, - 'example' => '', + 'example' => '10000001', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response nparameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], ], 'example' => '', ], @@ -5638,100 +2813,34 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], ], 403 => [ - [ - 'errorCode' => '%s.NotSupport', - 'errorMessage' => 'The specified resource type %s is not supported.', - 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.', - ], - [ - 'errorCode' => '%s.OverQuota', - 'errorMessage' => 'The quantity of %s exceeds the quota.', - 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.', - ], - [ - 'errorCode' => '%s.WrongValueMatched', - 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', - 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.', - ], - [ - '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' => 'The format of the rule configuration is invalid.Check the configuration for syntax errors or structural inconsistencies and correct them to meet the requirements.', - ], - [ - 'errorCode' => 'Rule.Config.Noncompliance', - 'errorMessage' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', - 'description' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', - ], - [ - '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' => 'The specified rule set name already exists.Try again with a unique name or modify the existing rule set name.', - ], - [ - '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' => '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.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'Expression.Invalid', - 'errorMessage' => 'The specified expression is invalid: %s.', - 'description' => 'The specified expression is invalid.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'BatchUpdateWafRules', + ['errorCode' => '%s.NotSupport', 'errorMessage' => 'The specified resource type %s is not supported.', 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.'], + ['errorCode' => '%s.OverQuota', 'errorMessage' => 'The quantity of %s exceeds the quota.', 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.'], + ['errorCode' => '%s.WrongValueMatched', 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.'], + ['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' => 'The format of the rule configuration is invalid.Check the configuration for syntax errors or structural inconsistencies and correct them to meet the requirements.'], + ['errorCode' => 'Rule.Config.Noncompliance', 'errorMessage' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', 'description' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.'], + ['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' => 'The specified rule set name already exists.Try again with a unique name or modify the existing rule set name.'], + ['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' => '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.'], + ['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' => '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.'], + ['errorCode' => 'Expression.Invalid', 'errorMessage' => 'The specified expression is invalid: %s.', 'description' => 'The specified expression is invalid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\"\\n}","type":"json"}]', + 'title' => 'Batch update WAF rules', 'changeSet' => [ - [ - 'createdAt' => '2025-04-17T07:08:14.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-09-25T07:02:52.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-23T06:19:49.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T06:13:37.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-04-17T07:08:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-25T07:02:52.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-23T06:19:49.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T06:13:37.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'BatchUpdateWafRules', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchUpdateWafRules'], ], ], 'ramActions' => [ @@ -5742,26 +2851,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => 'Blocks URLs.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Blocks access to specified URLs.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5774,22 +2873,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238896', - 'abilityTreeNodes' => [ - 'FEATUREdcdnSU2QP6', - ], + 'abilityTreeNodes' => ['FEATUREdcdnSU2QP6'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'Type', @@ -5797,15 +2887,13 @@ 'schema' => [ 'description' => 'The type. Valid values:'."\n" ."\n" - .'* **block**'."\n" - .'* **unblock**'."\n", + .'- **block**: blocks the URLs.'."\n" + .'- **unblock**: unblocks the URLs.', + 'enumValueTitles' => ['unblock' => 'Unblock.', 'block' => 'Block.'], 'type' => 'string', 'required' => true, + 'enum' => ['block', 'unblock'], 'example' => 'block', - 'enum' => [ - 'block', - 'unblock', - ], 'title' => '', ], ], @@ -5814,15 +2902,10 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The content to block.'."\n", + 'description' => 'The content to block.', 'type' => 'array', - 'items' => [ - 'description' => 'The URL.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://a.com/1.jpg', - 'title' => '', - ], + 'items' => ['description' => 'The URL.'."\n" + .'>The hostname in the URL must be a DNS record name (the RecordName field, which supports wildcard records) returned by ListRecords(SiteId). If you use a hostname that is not configured, the error InvalidParameter.RecordNotBelongToSite(400) is returned. Call ListRecords to obtain the RecordName first, and then use the RecordName as the hostname to construct the URL.>.', 'type' => 'string', 'required' => false, 'example' => 'http://a.com/1.jpg', 'title' => ''], 'required' => true, 'title' => '', 'example' => '', @@ -5831,52 +2914,18 @@ [ 'name' => 'Maxage', 'in' => 'query', - 'schema' => [ - 'description' => 'The period of time during which the URL is blocked. Unit: seconds. Specify this parameter if Type is set to block.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '864000', - 'minimum' => '600', - 'example' => '864000', - 'title' => '', - ], - ], - [ - 'name' => 'Extension', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The blocking period that you can extend. Set the value to 2year.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2year', - 'enum' => [ - '2year', - ], - 'title' => '', - ], + 'schema' => ['description' => 'The effective period of the block, in seconds. This parameter is required when the type is set to block.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '864000', 'minimum' => '600', 'example' => '864000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - ], - 'TaskId' => [ - 'description' => 'The blocking task ID.'."\n", - 'type' => 'string', - 'example' => '15940956620', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9'], + 'TaskId' => ['description' => 'The task ID. This ID is returned when you create a block task.', 'type' => 'string', 'example' => '15940956620', 'title' => ''], ], 'example' => '', ], @@ -5884,112 +2933,36 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingTimeParameter', - 'errorMessage' => 'The StartTime and EndTime must be both specified.', - 'description' => 'Please provide both a start time and an end time.', - ], - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], - [ - 'errorCode' => 'DomainNameOverLimit', - 'errorMessage' => 'A maximum of 500 domains are supported for each request.', - 'description' => 'Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.', - ], - [ - 'errorCode' => 'InvalidTime', - 'errorMessage' => 'The query time cannot exceed the last 3 days.', - 'description' => 'The query time cannot exceed the last 3 days.', - ], - [ - 'errorCode' => 'MissingParameter.ObjectType', - 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', - 'description' => 'Specify the ObjectType parameter.', - ], - [ - 'errorCode' => 'InvalidStationParameter', - 'errorMessage' => 'The specified Station is invalid.', - 'description' => 'The specified node parameter is invalid.', - ], - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests.Please try again later.', - 'description' => 'Requests are too frequent, please try again later.', - ], - [ - 'errorCode' => 'InvalidTaskId.Malformed', - 'errorMessage' => 'The specified taskId is invalid.', - 'description' => 'The specified task ID is invalid.', - ], - [ - 'errorCode' => 'InvalidParameters.InvalidUrls', - 'errorMessage' => 'The specified urls are invalid.', - 'description' => 'The requested URL parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The specified parameters are invalid.', - 'description' => 'Parameter is illegal.', - ], - [ - 'errorCode' => 'InvalidParameter.RecordNotBelongToSite', - 'errorMessage' => 'The record name passed in does not belong to the current site.', - 'description' => 'The record name passed in does not belong to the current site.', - ], + ['errorCode' => 'MissingTimeParameter', 'errorMessage' => 'The StartTime and EndTime must be both specified.', 'description' => 'Please provide both a start time and an end time.'], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'DomainNameOverLimit', 'errorMessage' => 'A maximum of 500 domains are supported for each request.', 'description' => 'Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.'], + ['errorCode' => 'InvalidTime', 'errorMessage' => 'The query time cannot exceed the last 3 days.', 'description' => 'The query time cannot exceed the last 3 days.'], + ['errorCode' => 'MissingParameter.ObjectType', 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', 'description' => 'Specify the ObjectType parameter.'], + ['errorCode' => 'InvalidStationParameter', 'errorMessage' => 'The specified Station is invalid.', 'description' => 'The specified node parameter is invalid.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], + ['errorCode' => 'InvalidTaskId.Malformed', 'errorMessage' => 'The specified taskId is invalid.', 'description' => 'The specified task ID is invalid.'], + ['errorCode' => 'InvalidParameters.InvalidUrls', 'errorMessage' => 'The specified urls are invalid.', 'description' => 'The requested URL parameter is invalid.'], + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The specified parameters are invalid.', 'description' => 'Parameter is illegal.'], + ['errorCode' => 'InvalidParameter.RecordNotBelongToSite', 'errorMessage' => 'The record name passed in does not belong to the current site.', 'description' => 'The record name passed in does not belong to the current site.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"TaskId\\": \\"15940956620\\"\\n}","type":"json"}]', - 'title' => 'BlockObject', + 'title' => 'URL blocking', 'changeSet' => [ - [ - 'createdAt' => '2025-03-13T07:58:30.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-24T06:04:31.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-03-13T07:58:30.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-24T06:04:31.000Z', 'description' => 'Error codes changed'], ], '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}', - ], - ], - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BlockObject'], ], ], + 'ramActions' => [], ], 'CheckSiteName' => [ 'summary' => 'Checks whether a specified website name is available.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -6002,22 +2975,14 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239613', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'SiteName', 'in' => 'query', - 'schema' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'example.com', - 'title' => '', - ], + 'schema' => ['description' => 'The website name.', 'type' => 'string', 'required' => true, 'example' => 'example.com', 'title' => ''], ], ], 'responses' => [ @@ -6025,48 +2990,29 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', - 'title' => '', - ], - 'Passed' => [ - 'description' => 'Indicates whether the verification passed.'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], - 'Messeage' => [ - 'description' => 'The verification message.'."\n", - 'type' => 'string', - 'example' => '站点名称可用。', - 'title' => '', - ], - 'Description' => [ - 'description' => 'The description of the verification result. Valid values:'."\n" - ."\n" - .'* **success**: The verification is successful.'."\n" - .'* **Site.AlreadyExist**: The website domain name has already been added.'."\n" - .'* **Site.InvalidName**: Invalid website domain name.'."\n" - .'* **Site.SubSiteUnavailable**: Subdomains are not allowed.'."\n" - .'* **Site.InternalError**: An internal error occurs.'."\n", - 'type' => 'string', - 'example' => 'success', - 'title' => '', - ], - 'IsSubSite' => [ - 'description' => 'Indicates whether a subdomain is specified. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'false', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', 'title' => ''], + 'Passed' => ['description' => 'Indicates whether the verification passed.'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Messeage' => ['description' => 'The verification message.', 'type' => 'string', 'example' => 'Site name is available.', 'title' => ''], + 'Description' => ['description' => 'The description of the verification result. Valid values:'."\n" + ."\n" + .'- **success**: The verification is successful.'."\n" + ."\n" + .'- **Site.AlreadyExist**: The website domain name has already been added.'."\n" + ."\n" + .'- **Site.InvalidName**: Invalid website domain name.'."\n" + ."\n" + .'- **Site.SubSiteUnavailable**: Subdomains are not allowed.'."\n" + ."\n" + .'- **Site.InternalError**: An internal error occurs.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'IsSubSite' => ['description' => 'Indicates whether a subdomain is specified. Valid values:'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', @@ -6076,32 +3022,19 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'SubSiteUnavailable', 'errorMessage' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.', 'description' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\",\\n \\"Passed\\": true,\\n \\"Messeage\\": \\"站点名称可用。\\",\\n \\"Description\\": \\"success\\",\\n \\"IsSubSite\\": false\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\",\\n \\"Passed\\": true,\\n \\"Messeage\\": \\"Site name is available.\\",\\n \\"Description\\": \\"success\\",\\n \\"IsSubSite\\": false\\n}","type":"json"}]', 'title' => 'CheckSiteName', 'changeSet' => [ - [ - 'createdAt' => '2024-09-18T08:22:14.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-18T08:22:14.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CheckSiteName', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckSiteName'], ], ], 'ramActions' => [ @@ -6112,12 +3045,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -6125,12 +3053,8 @@ ], 'CheckSiteProjectName' => [ 'summary' => 'Checks the name of a real-time log delivery task.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -6143,33 +3067,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239055', - 'abilityTreeNodes' => [ - 'FEATUREdcdn9K10I1', - ], + 'abilityTreeNodes' => ['FEATUREdcdn9K10I1'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the real-time log delivery task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'user_log', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the real-time log delivery task.'."\n", 'type' => 'string', 'required' => true, 'example' => 'user_log', 'title' => ''], ], [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12312312213212', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12312312213212', 'title' => ''], ], ], 'responses' => [ @@ -6179,33 +3088,13 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', - 'title' => '', - ], - 'Check' => [ - 'description' => 'Indicates whether the task name is valid. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], - 'ProjectName' => [ - 'description' => 'The name of the real-time log delivery task.'."\n", - 'type' => 'string', - 'example' => 'dcdn_waf_userAccount_log', - 'title' => '', - ], - 'Description' => [ - 'description' => 'The result description.'."\n", - 'type' => 'string', - 'example' => 'project name pass the check', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', 'title' => ''], + 'Check' => ['description' => 'Indicates whether the task name is valid. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ProjectName' => ['description' => 'The name of the real-time log delivery task.'."\n", 'type' => 'string', 'example' => 'dcdn_waf_userAccount_log', 'title' => ''], + 'Description' => ['description' => 'The result description.'."\n", 'type' => 'string', 'example' => 'project name pass the check', 'title' => ''], ], 'example' => '', ], @@ -6213,42 +3102,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'RealtimeLogProjectExistError', - 'errorMessage' => 'Realtime-log project name already exist.', - 'description' => 'Real-time log entry name already exists', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], + ['errorCode' => 'RealtimeLogProjectExistError', 'errorMessage' => 'Realtime-log project name already exist.', 'description' => 'Real-time log entry name already exists'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'CheckSiteProjectName', 'changeSet' => [ - [ - 'createdAt' => '2024-09-27T05:57:03.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-27T05:57:03.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CheckSiteProjectName', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckSiteProjectName'], ], ], 'ramActions' => [ @@ -6259,12 +3126,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -6276,12 +3138,8 @@ ], 'CheckUserProjectName' => [ 'summary' => 'Checks the name of a real-time log delivery task by account.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -6294,22 +3152,14 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238730', - 'abilityTreeNodes' => [ - 'FEATUREdcdn9K10I1', - ], + 'abilityTreeNodes' => ['FEATUREdcdn9K10I1'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the real-time log delivery task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-dcdn-log-56', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the real-time log delivery task.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ali-dcdn-log-56', 'title' => ''], ], ], 'responses' => [ @@ -6319,33 +3169,13 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', - 'title' => '', - ], - 'Check' => [ - 'description' => 'Indicates whether the name is valid. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], - 'ProjectName' => [ - 'description' => 'The name of the real-time log delivery task.'."\n", - 'type' => 'string', - 'example' => 'ali-dcdn-log-56', - 'title' => '', - ], - 'Description' => [ - 'description' => 'The reason why the name passed or failed the check.'."\n", - 'type' => 'string', - 'example' => 'project name pass the check', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', 'title' => ''], + 'Check' => ['description' => 'Indicates whether the name is valid. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ProjectName' => ['description' => 'The name of the real-time log delivery task.'."\n", 'type' => 'string', 'example' => 'ali-dcdn-log-56', 'title' => ''], + 'Description' => ['description' => 'The reason why the name passed or failed the check.'."\n", 'type' => 'string', 'example' => 'project name pass the check', 'title' => ''], ], 'example' => '', ], @@ -6353,53 +3183,24 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'RealtimeLogProjectExistError', - 'errorMessage' => 'Realtime-log project name already exist.', - 'description' => 'Real-time log entry name already exists', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], + ['errorCode' => 'RealtimeLogProjectExistError', 'errorMessage' => 'Realtime-log project name already exist.', 'description' => 'Real-time log entry name already exists'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], ], 403 => [ - [ - 'errorCode' => 'EsaService.NotOpen', - 'errorMessage' => 'ESA service has not opend.', - 'description' => 'Edge Security Accelerator (ESA) is not turned on', - ], + ['errorCode' => 'EsaService.NotOpen', 'errorMessage' => 'ESA service has not opend.', 'description' => 'Edge Security Accelerator (ESA) is not turned on'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'CheckUserProjectName', 'changeSet' => [ - [ - 'createdAt' => '2024-10-18T01:07:11.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-27T05:57:03.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-10-18T01:07:11.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-27T05:57:03.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CheckUserProjectName', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckUserProjectName'], ], ], 'ramActions' => [ @@ -6410,61 +3211,51 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CommitRoutineStagingCode' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Submits the staging (unstable) code of an Edge Routine and generates a production version.'."\n" + .'Prerequisite: Before calling this API operation, call GetRoutineStagingCodeUploadInfo to obtain OSS upload credentials. Upload the code file through OSS POST. After the upload callback succeeds, call this API operation to submit the code.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239216', - 'abilityTreeNodes' => [ - 'FEATUREdcdn75UYDO', - ], + 'abilityTreeNodes' => ['FEATUREdcdn75UYDO'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The routine name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-routine1', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Edge Routine.', 'type' => 'string', 'required' => true, 'example' => 'test-routine1', 'title' => ''], ], [ 'name' => 'CodeDescription', 'in' => 'formData', + 'schema' => ['description' => 'The description of the code version.', 'type' => 'string', 'required' => false, 'example' => 'description of this code ver', 'title' => ''], + ], + [ + 'name' => 'DeployEnv', + 'in' => 'formData', 'schema' => [ - 'description' => 'The description of the code version.'."\n", + 'description' => 'The deployment environment. The environment variable configuration of the specified environment is used. If you do not specify this parameter, environment variables are not used.', + 'enumValueTitles' => ['production' => 'production', 'staging' => 'staging'], 'type' => 'string', 'required' => false, - 'example' => 'description of this code ver', + 'example' => 'production', 'title' => '', ], ], @@ -6472,22 +3263,12 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', - ], - 'CodeVersion' => [ - 'description' => 'The version number of the newly generated code.'."\n", - 'type' => 'string', - 'example' => '1710120201067203242', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395'], + 'CodeVersion' => ['description' => 'The newly generated code version number.', 'type' => 'string', 'example' => '1710120201067203242', 'title' => ''], ], 'example' => '', ], @@ -6495,100 +3276,47 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'RoutineNotExist', - 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', - 'description' => 'The routine name does not exist. Check the routine name and try again.', - ], - [ - 'errorCode' => 'InternalOperationError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'ParameterNotExist', - 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', - 'description' => 'The specified parameter does not exist. Check your configurations and try again.', - ], - [ - 'errorCode' => 'DependedByOthers', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'RoutineUserServiceStatusHalt', - 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', - 'description' => 'Failed to update the configurations because you have overdue payments.', - ], - [ - 'errorCode' => 'UserOperationStatusIsLocked', - 'errorMessage' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', - 'description' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'CommitRoutineStagingCode', - 'summary' => 'Commits the unstable code in the staging environment to generate an official code version.', - 'changeSet' => [ - [ - 'createdAt' => '2024-12-04T05:48:48.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-11-05T06:54:07.000Z', - 'description' => 'Error codes changed', + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'RoutineNotExist', 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', 'description' => 'The routine name does not exist. Check the routine name and try again.'], + ['errorCode' => 'InternalOperationError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => '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.'], + ['errorCode' => 'ParameterNotExist', 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', 'description' => 'The specified parameter does not exist. Check your configurations and try again.'], + ['errorCode' => 'DependedByOthers', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'RoutineUserServiceStatusHalt', 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', 'description' => 'Failed to update the configurations because you have overdue payments.'], + ['errorCode' => 'UserOperationStatusIsLocked', 'errorMessage' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', 'description' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.'], ], ], - 'flowControl' => [ - 'flowControlList' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"CodeVersion\\": \\"1710120201067203242\\"\\n}","type":"json"}]', + 'title' => 'Submit edge routine staging code', + 'changeSet' => [ + ['createdAt' => '2024-12-04T05:48:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-05T06:54:07.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CommitRoutineStagingCode'], + ], ], 'ramActions' => [ [ - 'operationType' => 'none', + 'operationType' => 'create', 'ramAction' => [ 'action' => 'esa:CommitRoutineStagingCode', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"CodeVersion\\": \\"1710120201067203242\\"\\n}","type":"json"}]', - 'operationType' => 'write', ], 'CreateCacheRule' => [ - 'summary' => 'Create a new site cache configuration', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Create a Site Cache Configuration.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -6601,385 +3329,266 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257996', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '340035003106221', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to get this ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '340035003106221', 'title' => ''], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the version for the configuration to take effect. The default is version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The site configuration version. For sites with version management enabled, this parameter specifies the site version to which the configuration applies.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. This parameter is not required for a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Possible values:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable the rule. This parameter is not required for a global configuration. Valid values:'."\n" + ."\n" + .'- `on`: Enables the rule.'."\n" + ."\n" + .'- `off`: Disables the rule.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq \\"video.example.com\\")'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The content of the rule, which is a conditional expression used to match user requests. This parameter is not required for a global configuration.'."\n" + ."\n" + .'- To match all requests, set the value to `true`.'."\n" + ."\n" + .'- To match specific requests, set the value to a custom expression, such as `(http.host eq "video.example.com")`.', 'type' => 'string', 'required' => false, 'example' => '(http.host eq \\"video.example.com\\")'."\n", 'title' => ''], ], [ 'name' => 'BypassCache', 'in' => 'query', - 'schema' => [ - 'description' => 'Set the bypass cache mode. Possible values:'."\n" - .'- cache_all: Cache all requests.'."\n" - .'- bypass_all: Bypass cache for all requests.', - 'type' => 'string', - 'required' => false, - 'example' => 'cache_all', - 'title' => '', - ], + 'schema' => ['description' => 'The bypass cache mode. Valid values:'."\n" + ."\n" + .'- `cache_all`: Caches all requests.'."\n" + ."\n" + .'- `bypass_all`: Bypasses the cache for all requests.', 'type' => 'string', 'required' => false, 'example' => 'cache_all', 'title' => ''], ], [ 'name' => 'BrowserCacheMode', 'in' => 'query', - 'schema' => [ - 'description' => 'Browser cache mode. Possible values:'."\n" - .'- no_cache: Do not cache.'."\n" - .'- follow_origin: Follow the origin server\'s cache policy.'."\n" - .'- override_origin: Override the origin server\'s cache policy.', - 'type' => 'string', - 'required' => false, - 'example' => 'follow_origin', - 'title' => '', - ], + 'schema' => ['description' => 'The browser cache mode. Valid values:'."\n" + ."\n" + .'- `no_cache`: Disables browser caching.'."\n" + ."\n" + .'- `follow_origin`: Follows the origin server cache policy.'."\n" + ."\n" + .'- `override_origin`: Overrides the origin server cache policy.', 'type' => 'string', 'required' => false, 'example' => 'follow_origin', 'title' => ''], ], [ 'name' => 'BrowserCacheTtl', 'in' => 'query', - 'schema' => [ - 'description' => 'Browser cache expiration time, in seconds.', - 'type' => 'string', - 'required' => false, - 'example' => '300', - 'title' => '', - ], + 'schema' => ['description' => 'The browser cache TTL, in seconds.', 'type' => 'string', 'required' => false, 'example' => '300', 'title' => ''], ], [ 'name' => 'EdgeCacheMode', 'in' => 'query', - 'schema' => [ - 'description' => 'Edge cache mode. Possible values:'."\n" - .'- follow_origin: Follow the origin server\'s cache policy (if it exists), otherwise use the default cache policy.'."\n" - .'- no_cache: Do not cache.'."\n" - .'- override_origin: Override the origin server\'s cache policy.'."\n" - .'- follow_origin_bypass: Follow the origin server\'s cache policy (if it exists), otherwise do not cache.', - 'type' => 'string', - 'required' => false, - 'example' => 'follow_origin', - 'title' => '', - ], + 'schema' => ['description' => 'The edge cache mode. Valid values:'."\n" + ."\n" + .'- `follow_origin`: Follows the origin server cache policy if one exists; otherwise, uses the default cache policy.'."\n" + ."\n" + .'- `no_cache`: Disables caching on the edge node.'."\n" + ."\n" + .'- `override_origin`: Overrides the origin server cache policy.'."\n" + ."\n" + .'- `follow_origin_bypass`: Follows the origin server cache policy if one exists; otherwise, the content is not cached.'."\n" + ."\n" + .'- `follow_origin_override`: Follows the origin server cache policy if one exists; otherwise, uses a custom edge cache TTL.', 'type' => 'string', 'required' => false, 'example' => 'follow_origin', 'title' => ''], ], [ 'name' => 'EdgeCacheTtl', 'in' => 'query', - 'schema' => [ - 'description' => 'Edge cache expiration time, in seconds.', - 'type' => 'string', - 'required' => false, - 'example' => '300', - 'title' => '', - ], + 'schema' => ['description' => 'The edge cache TTL, in seconds.', 'type' => 'string', 'required' => false, 'example' => '300', 'title' => ''], ], [ 'name' => 'EdgeStatusCodeCacheTtl', 'in' => 'query', - 'schema' => [ - 'description' => 'Status code cache expiration time, in seconds.', - 'type' => 'string', - 'required' => false, - 'example' => '4xx=10', - 'title' => '', - ], + 'schema' => ['description' => 'The status code cache TTL, in seconds.'."\n" + ."\n" + .'- You can set the cache TTL for a specific status code. For example, `404=10` caches responses with a 404 status code for 10 seconds.'."\n" + ."\n" + .'- You can set the cache TTL for a series of status codes, such as 4xx or 5xx. For example, `4xx=10` caches all responses that have a status code in the 4xx series for 10 seconds.'."\n" + ."\n" + .'- You can specify multiple status code TTLs, separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => '5xx=0,404=10', 'title' => ''], ], [ 'name' => 'SortQueryStringForCache', 'in' => 'query', - 'schema' => [ - 'description' => 'Query string sorting, disabled by default. Possible values:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to sort query strings. This feature is disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: Enables sorting.'."\n" + ."\n" + .'- `off`: Disables sorting.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'QueryStringMode', 'in' => 'query', - 'schema' => [ - 'description' => 'The processing mode for query strings when generating the cache key. Possible values:'."\n" - .'- ignore_all: Ignore all.'."\n" - .'- exclude_query_string: Exclude specified query strings.'."\n" - .'- reserve_all: Default, reserve all.'."\n" - .'- include_query_string: Include specified query strings.', - 'type' => 'string', - 'required' => false, - 'example' => 'reserve_all', - 'title' => '', - ], + 'schema' => ['description' => 'The mode for processing query strings when generating a cache key. Valid values:'."\n" + ."\n" + .'- `ignore_all`: Ignores all query strings.'."\n" + ."\n" + .'- `exclude_query_string`: Excludes specified query strings.'."\n" + ."\n" + .'- `reserve_all`: Includes all query strings (the default).'."\n" + ."\n" + .'- `include_query_string`: Includes only specified query strings.', 'type' => 'string', 'required' => false, 'example' => 'reserve_all', 'title' => ''], ], [ 'name' => 'QueryString', 'in' => 'query', - 'schema' => [ - 'description' => 'Query strings to be reserved or excluded. Multiple values are supported, separated by spaces.', - 'type' => 'string', - 'required' => false, - 'example' => 'example', - 'title' => '', - ], + 'schema' => ['description' => 'The query strings to include in or exclude from the cache key. Separate multiple query strings with spaces.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], ], [ 'name' => 'IncludeHeader', 'in' => 'query', - 'schema' => [ - 'description' => 'When generating the cache key, add the specified header names and their values. Multiple values are supported, separated by spaces.', - 'type' => 'string', - 'required' => false, - 'example' => 'example', - 'title' => '', - ], + 'schema' => ['description' => 'The headers to include in the cache key. Both the header names (case-insensitive) and their values are included. Separate multiple header names with spaces. The header names can contain the following characters:'."\n" + ."\n" + .'- Symbols: ! # $ % & \' \\* + - . ^ \\_ | \\~'."\n" + ."\n" + .'- Digits: 0-9'."\n" + ."\n" + .'- Letters: a-z (lowercase)', 'type' => 'string', 'required' => false, 'example' => 'headername1 headername2', 'title' => ''], ], [ 'name' => 'IncludeCookie', 'in' => 'query', - 'schema' => [ - 'description' => 'When generating the cache key, add the specified cookie names and their values. Multiple values are supported, separated by spaces.', - 'type' => 'string', - 'required' => false, - 'example' => 'cookie_exapmle', - 'title' => '', - ], + 'schema' => ['description' => 'The cookies to include in the cache key. Both the cookie names (case-insensitive) and their values are included. Separate multiple cookie names with spaces. The cookie names can contain the following characters:'."\n" + ."\n" + .'- Symbols: ! # $ % & \' \\* + - . ^ \\_ | \\~'."\n" + ."\n" + .'- Digits: 0-9'."\n" + ."\n" + .'- Letters: a-z (lowercase)', 'type' => 'string', 'required' => false, 'example' => 'cookiename1 cookiename2', 'title' => ''], ], [ 'name' => 'CacheReserveEligibility', 'in' => 'query', - 'schema' => [ - 'description' => 'Cache retention eligibility. Used to control whether user requests bypass the cache retention node when returning to the origin. Possible values:'."\n" - .'- bypass_cache_reserve: Requests bypass cache retention.'."\n" - .'- eligible_for_cache_reserve: Eligible for cache retention.', - 'type' => 'string', - 'required' => false, - 'example' => 'bypass_cache_reserve', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether requests bypass cache reservation nodes during an origin fetch. Valid values:'."\n" + ."\n" + .'- `bypass_cache_reserve`: The request bypasses cache reservation.'."\n" + ."\n" + .'- `eligible_for_cache_reserve`: The request is eligible for cache reservation.', 'type' => 'string', 'required' => false, 'example' => 'bypass_cache_reserve', 'title' => ''], ], [ 'name' => 'CheckPresenceHeader', 'in' => 'query', - 'schema' => [ - 'description' => 'When generating the cache key, check if the header exists. If it does, add the header name (case-insensitive) to the cache key. Multiple header names are supported, separated by spaces.', - 'type' => 'string', - 'required' => false, - 'example' => 'headername', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies the headers to check for presence when generating a cache key. If a specified header is present in the request, its name (case-insensitive) is included in the cache key. To specify multiple headers, separate their names with spaces. The header names can contain the following characters:'."\n" + ."\n" + .'- Symbols: ! # $ % & \' \\* + - . ^ \\_ | \\~'."\n" + ."\n" + .'- Digits: 0-9'."\n" + ."\n" + .'- Letters: a-z (lowercase)', 'type' => 'string', 'required' => false, 'example' => 'headername1 headername2', 'title' => ''], ], [ 'name' => 'CheckPresenceCookie', 'in' => 'query', - 'schema' => [ - 'description' => 'When generating the cache key, check if the cookie exists. If it does, add the cookie name (case-insensitive) to the cache key. Multiple cookie names are supported, separated by spaces.', - 'type' => 'string', - 'required' => false, - 'example' => 'cookiename', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies the cookies to check for presence when generating a cache key. If a specified cookie is present in the request, its name (case-insensitive) is included in the cache key. To specify multiple cookies, separate their names with spaces. The cookie names can contain the following characters:'."\n" + ."\n" + .'- Symbols: ! # $ % & \' \\* + - . ^ \\_ | \\~'."\n" + ."\n" + .'- Digits: 0-9'."\n" + ."\n" + .'- Letters: a-z (lowercase)', 'type' => 'string', 'required' => false, 'example' => 'cookiename1 cookiename2', 'title' => ''], ], [ 'name' => 'UserDeviceType', 'in' => 'query', - 'schema' => [ - 'description' => 'When generating the cache key, include the client device type. Possible values:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to include the client device type in the cache key. Valid values:'."\n" + ."\n" + .'- `on`: Includes the client device type.'."\n" + ."\n" + .'- `off`: Does not include the client device type.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'UserGeo', 'in' => 'query', - 'schema' => [ - 'description' => 'Include the client\'s geographical location when generating the cache key. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to include the client\'s geographic location in the cache key. Valid values:'."\n" + ."\n" + .'- `on`: Includes the geographic location.'."\n" + ."\n" + .'- `off`: Does not include the geographic location.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'UserLanguage', 'in' => 'query', - 'schema' => [ - 'description' => 'Include the client\'s language type when generating the cache key. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to include the client\'s language in the cache key. Valid values:'."\n" + ."\n" + .'- `on`: Includes the language.'."\n" + ."\n" + .'- `off`: Does not include the language.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'ServeStale', 'in' => 'query', - 'schema' => [ - 'description' => 'Serve stale cache. When enabled, the node can still use the expired cached files to respond to user requests even if the origin server is unavailable. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to serve stale content. If enabled, an edge node can serve stale (expired) content when the origin server is unavailable. Valid values:'."\n" + ."\n" + .'- `on`: Enables serving stale content.'."\n" + ."\n" + .'- `off`: Disables serving stale content.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'AdditionalCacheablePorts', 'in' => 'query', - 'schema' => [ - 'description' => 'Enable caching on specified ports. Value range: 8880, 2052, 2082, 2086, 2095, 2053, 2083, 2087, 2096', - 'type' => 'string', - 'required' => false, - 'example' => '8880', - 'title' => '', - ], + 'schema' => ['description' => '- Specifies additional ports on which caching is enabled.'."\n" + ."\n" + .'- Valid values: 8880, 2052, 2082, 2086, 2095, 2053, 2083, 2087, and 2096.'."\n" + ."\n" + .'- You can specify multiple ports, separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => '8880,2052,2086', 'title' => ''], ], [ 'name' => 'CacheDeceptionArmor', 'in' => 'query', - 'schema' => [ - 'description' => 'Cache deception defense. Used to defend against web cache deception attacks; only the verified cache content will be cached. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable cache deception defense. This feature helps defend against web cache deception attacks. When this feature is enabled, only content that passes validation is cached. Valid values:'."\n" + ."\n" + .'- `on`: Enables the defense.'."\n" + ."\n" + .'- `off`: Disables the defense.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule execution order. Rules with smaller values are executed first.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The execution order of the rule. A smaller number indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PostCache', 'in' => 'query', - 'schema' => [ - 'description' => 'Toggle for the Post cache feature.', - 'title' => 'Toggle for the Post cache feature.', - 'type' => 'string', - 'example' => 'on', - 'required' => false, - ], + 'schema' => ['title' => 'Toggle for the Post cache feature.', 'description' => 'Specifies whether to enable POST request caching.', 'type' => 'string', 'example' => 'on', 'required' => false], ], [ 'name' => 'PostBodySizeLimit', 'in' => 'query', - 'schema' => [ - 'description' => 'Body size limit. The value is a numeric value in KB. Body sizes from 1 KB to 8 KB are supported. If the value is empty, it defaults to 8 KB.', - 'type' => 'string', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The size limit for the request body when using POST request caching, in KB. Supported values range from 1 to 8. If unspecified, the default is 8 KB.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PostBodyCacheKey', 'in' => 'query', - 'schema' => [ - 'description' => 'Processing pattern for the cache key.', - 'title' => 'Processing pattern for the cache key.', - 'type' => 'string', - 'example' => 'ignore', - 'required' => false, - ], + 'schema' => ['title' => 'Processing pattern for the cache key.', 'description' => 'Specifies how to process the request body when generating a cache key for POST requests. The following modes are supported:'."\n" + ."\n" + .'- `md5`: Calculates the MD5 hash of the request body and adds the hash value to the cache key.'."\n" + ."\n" + .'- `ignore`: Ignores the request body when the cache key is generated.', 'type' => 'string', 'example' => 'ignore', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n", - ], - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '352816096987136', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n"], + 'ConfigId' => ['description' => 'The ID of the configuration.', 'type' => 'integer', 'format' => 'int64', 'example' => '352816096987136', 'title' => ''], ], 'example' => '', ], @@ -6987,168 +3596,64 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\\\n\\",\\n \\"ConfigId\\": 352816096987136\\n}","type":"json"}]', 'title' => 'Add Site Cache Configuration', 'changeSet' => [ - [ - 'createdAt' => '2025-03-27T02:58:48.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-03-27T02:58:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateCacheRule', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCacheRule'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateCacheRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], ], 'CreateClientCertificate' => [ - 'summary' => 'Uses the ESA-managed certificate authority (CA) to issue client certificates.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Issues a client certificate by using the ESA certificate authority (CA).', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7161,39 +3666,25 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239158', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'CSR', 'in' => 'formData', - 'schema' => [ - 'description' => 'The certificate signing request (CSR).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '-----BEGIN CERTIFICATE REQUEST-----', - 'title' => '', - ], + 'schema' => ['description' => 'The certificate signing request (CSR) content.', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN CERTIFICATE REQUEST-----', 'title' => ''], ], [ 'name' => 'PkeyType', 'in' => 'formData', 'schema' => [ - 'description' => 'The type of the private key algorithm.'."\n", + 'description' => 'The private key algorithm type. This parameter is required if CSR is not provided.', + 'enumValueTitles' => ['RSA' => 'RSA', 'ECC' => 'ECC'], 'type' => 'string', 'required' => false, 'example' => 'RSA', @@ -7203,107 +3694,30 @@ [ 'name' => 'ValidityDays', 'in' => 'formData', - 'schema' => [ - 'description' => 'The validity period of the certificate. Unit: day.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '365', - 'title' => '', - ], + 'schema' => ['description' => 'The validity period of the certificate. Unit: days.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '365', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E', - 'title' => '', - ], - 'Id' => [ - 'description' => 'The certificate ID on ESA.'."\n", - 'type' => 'string', - 'example' => 'babaded901474b9693acf530e0fb1d95', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the certificate.'."\n", - 'type' => 'string', - 'example' => 'active', - 'title' => '', - ], - 'Certificate' => [ - 'description' => 'The certificate content.'."\n", - 'type' => 'string', - 'example' => '-----BEGIN CERTIFICATE-----', - 'title' => '', - ], - 'PrivateKey' => [ - 'description' => 'The private key of the certificate.'."\n", - 'type' => 'string', - 'example' => '-----BEGIN PRIVATE KEY-----', - 'title' => '', - ], - 'CommonName' => [ - 'description' => 'The Common Name of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com ', - 'title' => '', - ], - 'NotBefore' => [ - 'description' => 'The time when the certificate takes effect.'."\n", - 'type' => 'string', - 'example' => '2023-12-01T02:12:49Z', - 'title' => '', - ], - 'NotAfter' => [ - 'description' => 'The time when the certificate expires.'."\n", - 'type' => 'string', - 'example' => '2024-12-01T02:12:49Z', - 'title' => '', - ], - 'Issuer' => [ - 'description' => 'The CA that issued the certificate.'."\n", - 'type' => 'string', - 'example' => 'ESA CA', - 'title' => '', - ], - 'SerialNumber' => [ - 'description' => 'The serial number of the certificate.'."\n", - 'type' => 'string', - 'example' => 'babaded901474b9693acf530e0fb1daa', - 'title' => '', - ], - 'FingerprintSha256' => [ - 'description' => 'The SHA-256 fingerprint of the certificate.'."\n", - 'type' => 'string', - 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66', - 'title' => '', - ], - 'SignatureAlgorithm' => [ - 'description' => 'The signature algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'SHA256-RSA', - 'title' => '', - ], - 'ValidityDays' => [ - 'description' => 'The validity period of the certificate. Unit: day.'."\n", - 'type' => 'string', - 'example' => '365', - 'title' => '', - ], - 'CACertificateId' => [ - 'description' => 'The ID of the CA certificate.'."\n", - 'type' => 'string', - 'example' => 'babaded901474b9693acf530e0fb1dbb', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E', 'title' => ''], + 'Id' => ['description' => 'The certificate ID.', 'type' => 'string', 'example' => 'babaded901474b9693acf530e0fb1d95', 'title' => ''], + 'Status' => ['description' => 'The certificate status.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'Certificate' => ['description' => 'The certificate content.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----', 'title' => ''], + 'PrivateKey' => ['description' => 'The private key of the certificate.', 'type' => 'string', 'example' => '-----BEGIN PRIVATE KEY-----', 'title' => ''], + 'CommonName' => ['description' => 'The common name of the certificate.', 'type' => 'string', 'example' => 'www.example.com ', 'title' => ''], + 'NotBefore' => ['description' => 'The start time of the certificate validity period.', 'type' => 'string', 'example' => '2023-12-01T02:12:49Z', 'title' => ''], + 'NotAfter' => ['description' => 'The end time of the certificate validity period.', 'type' => 'string', 'example' => '2024-12-01T02:12:49Z', 'title' => ''], + 'Issuer' => ['description' => 'The certification authority that issued the certificate.', 'type' => 'string', 'example' => 'ESA CA', 'title' => ''], + 'SerialNumber' => ['description' => 'The certificate serial number.', 'type' => 'string', 'example' => 'babaded901474b9693acf530e0fb1daa', 'title' => ''], + 'FingerprintSha256' => ['description' => 'The SHA-256 fingerprint of the certificate.', 'type' => 'string', 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66', 'title' => ''], + 'SignatureAlgorithm' => ['description' => 'The signature algorithm of the certificate.', 'type' => 'string', 'example' => 'SHA256-RSA', 'title' => ''], + 'ValidityDays' => ['description' => 'The validity period of the certificate.', 'type' => 'string', 'example' => '365', 'title' => ''], + 'CACertificateId' => ['description' => 'The CA certificate ID.', 'type' => 'string', 'example' => 'babaded901474b9693acf530e0fb1dbb', 'title' => ''], ], 'example' => '', ], @@ -7311,56 +3725,23 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.Function', - 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', - 'description' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', - ], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'QuotaCheckFailed.Function', 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', 'description' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], ], '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"}]', - 'title' => 'CreateClientCertificate', + 'title' => 'Create a client certificate', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateClientCertificate', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateClientCertificate'], ], ], 'ramActions' => [ @@ -7371,24 +3752,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], ], 'CreateCompressionRule' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Creates a compression rule configuration for a site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7401,91 +3774,58 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257663', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1231231221***', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1231231221***', 'title' => ''], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the effective version of the site configuration, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version on which the configuration takes effect. The default value is version 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. You do not need to set this parameter when adding a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', + 'description' => 'The rule switch. You do not need to set this parameter when adding a global configuration. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- To match all incoming requests: Set the value to true'."\n" - .'- To match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], + 'schema' => ['description' => 'The rule content, which uses a conditional expression to match user requests. You do not need to set this parameter when adding a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + .'- Match specified requests: Set the value to a custom expression, for example, (http.host eq \\"video.example.com\\").', 'type' => 'string', 'required' => false, 'example' => '(http.host eq "video.example.com")', 'title' => ''], ], [ 'name' => 'Gzip', 'in' => 'query', 'schema' => [ - 'description' => 'Gzip compression. Value range:'."\n" + 'description' => 'Gzip compression. Valid values:'."\n" ."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', - 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], + 'required' => false, 'title' => '', ], ], @@ -7493,17 +3833,14 @@ 'name' => 'Brotli', 'in' => 'query', 'schema' => [ - 'description' => 'Brotli compression. Value range:'."\n" + 'description' => 'Brotli compression. Valid values:'."\n" ."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', - 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], + 'required' => false, 'title' => '', ], ], @@ -7511,53 +3848,32 @@ 'name' => 'Zstd', 'in' => 'query', 'schema' => [ - 'description' => 'Zstd compression. Value range:'."\n" + 'description' => 'Zstd compression. Valid values:'."\n" ."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', - 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], + 'required' => false, 'title' => '', ], ], [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule execution order. Rules with smaller numeric values are executed first. ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Request response result.', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E', - ], - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '35281609698****', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E'], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '35281609698****', 'title' => ''], ], 'example' => '', ], @@ -7565,188 +3881,56 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['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' => '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.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'Create Compression Rule Configuration', - 'summary' => 'Add a compression rule', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C370DAF1-C838-4288-A1A0-9A87633D248E\\",\\n \\"ConfigId\\": 0\\n}","type":"json"}]', + 'title' => 'Create a compression rule configuration', 'changeSet' => [ - [ - 'createdAt' => '2025-03-27T02:58:48.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2025-02-12T02:25:41.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-03-27T02:58:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-12T02:25:41.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateCompressionRule', - ], + ['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' => 'Creates a Software as a Service (SaaS) domain name for a site.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Creates a SaaS domain name for a site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7759,66 +3943,40 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239598', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4DMKZ4', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4DMKZ4'], ], 'parameters' => [ [ 'name' => 'Hostname', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The Software as a Service (SaaS) domain name.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'custom.site.com', - ], + 'schema' => ['title' => '', 'description' => 'The SaaS domain name.', 'type' => 'string', 'required' => true, 'example' => 'custom.site.com'], ], [ 'name' => 'SiteId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The ID of the site. To obtain the site ID, call the [ListSites](~~2850189~~) operation.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'title' => '', - 'example' => '1234567890123', - ], + 'schema' => ['title' => '', 'description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123'], ], [ 'name' => 'RecordId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The ID of the record to attach. To obtain the record ID, call the [ListRecords](~~2850265~~) operation.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'title' => '', - 'example' => '1234567890123', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the record to bind. You can call the [ListRecords](~~2850265~~) operation to obtain the record ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123'], ], [ 'name' => 'SslFlag', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ - 'description' => 'The SSL switch.'."\n" - ."\n" - .'- **on**: Enables SSL.'."\n" - ."\n" - .'- **off**: Disables SSL.', + 'title' => '', + 'description' => 'Specifies whether to enable SSL. Valid values:'."\n" + .'- **on**: Enable SSL.'."\n" + .'- **off**: Disable SSL.', + 'enumValueTitles' => ['off' => 'Disable SSL.', 'on' => 'Enable SSL.'], 'type' => 'string', 'required' => true, - 'enum' => [ - 'on', - 'off', - ], - 'title' => '', + 'enum' => ['on', 'off'], 'example' => 'on', ], ], @@ -7826,20 +3984,14 @@ 'name' => 'CertType', 'in' => 'query', 'schema' => [ - 'description' => 'The certificate type. This parameter is required when SslFlag is set to on.'."\n" - ."\n" + 'title' => '', + 'description' => 'The certificate type. This parameter is required when SslFlag is set to on. Valid values:'."\n" .'- **free**: free certificate.'."\n" - ."\n" .'- **upload**: uploaded certificate.'."\n" - ."\n" - .'- **cas**: Alibaba Cloud Security certificate.', + .'- **cas**: SSL Certificates Service certificate.', + 'enumValueTitles' => ['cas' => 'SSL Certificates Service certificate.', 'upload' => 'Uploaded certificate.', 'free' => 'Free certificate.'], 'type' => 'string', - 'enum' => [ - 'free', - 'upload', - 'cas', - ], - 'title' => '', + 'enum' => ['free', 'upload', 'cas'], 'required' => false, 'example' => 'free', ], @@ -7848,53 +4000,26 @@ 'name' => 'Certificate', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The content of the certificate. This parameter is required when CertType is set to upload.', - 'type' => 'string', - 'title' => '', - 'required' => false, - 'example' => '-----BEGIN CERTIFICATE-----', - ], + 'schema' => ['title' => '', 'description' => 'The certificate content. This parameter is required when CertType is set to upload.', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN CERTIFICATE-----'], ], [ 'name' => 'PrivateKey', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The private key of the certificate. This parameter is required when CertType is set to upload.', - 'type' => 'string', - 'title' => '', - 'required' => false, - 'example' => '-----BEGIN PRIVATE KEY-----', - ], + 'schema' => ['title' => '', 'description' => 'The certificate private key. This parameter is required when CertType is set to upload.', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN PRIVATE KEY-----'], ], [ 'name' => 'CasId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud Security certificate. This parameter is required when CertType is set to cas.', - 'type' => 'integer', - 'format' => 'int64', - 'title' => '', - 'required' => false, - 'example' => '30000478'."\n", - ], + 'schema' => ['title' => '', 'description' => 'The SSL Certificates Service certificate ID. This parameter is required when CertType is set to cas.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30000478'."\n"], ], [ 'name' => 'CasRegion', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The region of the Alibaba Cloud Security certificate. This parameter is required when CertType is set to cas.'."\n" - ."\n" - .'- For accounts on the Alibaba Cloud China Website (www\\.aliyun.com), set this parameter to cn-hangzhou.'."\n" - ."\n" - .'- For accounts on the Alibaba Cloud International Website (www\\.alibabacloud.com), set this parameter to ap-southeast-1.', - 'type' => 'string', - 'title' => '', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The region of the SSL Certificates Service certificate. This parameter is required when CertType is set to cas.'."\n" + .'- For Chinese site accounts, set this parameter to cn-hangzhou.'."\n" + .'- For International site accounts, set this parameter to ap-southeast-1.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -7902,25 +4027,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique request ID, generated by Alibaba Cloud.', - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - 'title' => '', - ], - 'HostnameId' => [ - 'description' => 'The ID of the SaaS domain name.', - 'type' => 'integer', - 'format' => 'int64', - 'title' => '', - 'example' => '1234567890123', - ], - 'Hostname' => [ - 'description' => 'The SaaS domain name.', - 'type' => 'string', - 'title' => '', - 'example' => 'custom.site.com', - ], + 'RequestId' => ['description' => 'The request ID, which is a unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', 'title' => ''], + 'HostnameId' => ['title' => '', 'description' => 'The ID of the SaaS domain name.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123'], + 'Hostname' => ['title' => '', 'description' => 'The SaaS domain name.', 'type' => 'string', 'example' => 'custom.site.com'], ], 'description' => '', 'title' => '', @@ -7930,67 +4039,37 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'Site.ServiceBusy', - 'errorMessage' => 'This website is being configured. Try again later.', - 'description' => 'This website is being configured. Try again later.', - ], - [ - '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' => 'The custom hostname conflicts with existing resources, such as sites, records, load balancers, source address pools, custom hostnames and Layer 4 proxy records.', - ], - [ - 'errorCode' => 'QuotaExceed.CustomHostname', - 'errorMessage' => 'The number of custom hostnames exceeds the plan quota. Contact the sales team to increase your quota.', - 'description' => 'The number of custom hostnames exceeds the plan quota. Contact the sales team to increase your quota.', - ], - [ - 'errorCode' => 'CustomHostname.ApplyCertFailed', - 'errorMessage' => 'Fail to apply a free cert for custom hostname. Please try again later.', - 'description' => 'Fail to apply a free cert for custom hostname. Please try again later.', - ], - [ - 'errorCode' => 'CustomHostname.SetCertFailed', - 'errorMessage' => 'Fail to deploy a cert for custom hostname. Please try again later.', - 'description' => 'Fail to deploy a cert for custom hostname. Please try again later.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'Site.ServiceBusy', 'errorMessage' => 'This website is being configured. Try again later.', 'description' => 'This website is being configured. Try again later.'], + ['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' => 'The custom hostname conflicts with existing resources, such as sites, records, load balancers, source address pools, custom hostnames and Layer 4 proxy records.'], + ['errorCode' => 'CustomHostname.ApplyCertFailed', 'errorMessage' => 'Fail to apply a free cert for custom hostname. Please try again later.', 'description' => 'Fail to apply a free cert for custom hostname. Please try again later.'], + ['errorCode' => 'CustomHostname.SetCertFailed', 'errorMessage' => 'Fail to deploy a cert for custom hostname. Please try again later.', 'description' => 'Fail to deploy a cert for custom hostname. Please try again later.'], + ['errorCode' => 'CustomHostname.CheckQuotaFailed', 'errorMessage' => 'Fail to check quota for custom hostname. Please try again later.', 'description' => ''], + ['errorCode' => 'CustomHostname.OfflineForMultiReason', 'errorMessage' => 'Unable to activate the custom hostname because it is offline due to multiple reasons.', 'description' => ''], + ['errorCode' => 'CustomHostname.WildcardDomainRequireEnterprisePlan', 'errorMessage' => 'Wildcard custom hostnames require an Enterprise plan.', 'description' => ''], + ['errorCode' => 'CustomHostname.QueryCasCertFailed', 'errorMessage' => 'Fail to query CAS certificate details. Please try again later.', 'description' => ''], + ['errorCode' => 'QuotaExceed.CustomHostname', 'errorMessage' => 'The number of custom hostnames exceeds the plan quota. Contact the sales team to increase your quota.', 'description' => 'The number of custom hostnames exceeds the plan quota. Contact the sales team to increase your quota.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'CreateCustomHostname', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a saaS domain name', + 'description' => '- If the acceleration area is set to the Chinese mainland only or global, the site domain name must have a valid China Internet Content Provider (ICP) filing.'."\n" + .'- Each user can invoke this operation up to 100 times per hour.', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 3600, 'regionId' => '*', 'api' => 'CreateCustomHostname'], + ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"HostnameId\\": 1234567890123,\\n \\"Hostname\\": \\"custom.site.com\\"\\n}","type":"json"}]', ], 'CreateCustomResponseCodeRule' => [ - 'summary' => 'Add a custom response code configuration for a site.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Creates a custom response code rule for a site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -8003,60 +4082,34 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257646', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID. Call the [ListSites](~~2850189~~) API to get it.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '805864735361584', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call [ListSites](~~2850189~~) to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '805864735361584', 'title' => ''], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Site configuration version number. For sites with version management enabled, use this parameter to specify the site version where the configuration takes effect. The default is version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version on which the configuration takes effect. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. Do not set this parameter when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. You do not need to set this parameter when adding a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Rule switch. Do not set this parameter when adding a global configuration. Valid values:'."\n" - ."\n" - .'- on: Enable.'."\n" - ."\n" - .'- off: Disable.', + 'description' => 'The rule switch. You do not need to set this parameter when adding a global configuration. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', - 'enum' => [ - 'on', - 'off', - ], + 'enum' => ['on', 'off'], 'required' => false, 'example' => 'on', 'title' => '', @@ -8065,73 +4118,35 @@ [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content. Use a conditional expression to match user requests. Do not set this parameter when adding a global configuration. There are two scenarios:'."\n" - ."\n" - .'- Match all incoming requests: Set the value to true.'."\n" - ."\n" - .'- Match specific requests: Set the value to a custom expression, such as: (http.host eq "video.example.com").', - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], + 'schema' => ['description' => 'The rule content. Conditional expressions are used to match user requests. You do not need to set this parameter when adding a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + .'- Match specified requests: Set the value to a custom expression, such as (http.host eq "video.example.com").', 'type' => 'string', 'required' => false, 'example' => '(http.host eq "video.example.com")', 'title' => ''], ], [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule execution order. A smaller value indicates higher priority.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The execution order of the rule. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ReturnCode', 'in' => 'query', - 'schema' => [ - 'description' => 'Response code.', - 'type' => 'string', - 'required' => false, - 'example' => '400', - 'title' => '', - ], + 'schema' => ['title' => '', 'description' => 'The response code.', 'type' => 'string', 'required' => true, 'example' => '400'], ], [ 'name' => 'PageId', 'in' => 'query', - 'schema' => [ - 'description' => 'Response page.', - 'type' => 'string', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['title' => '', 'description' => 'The response page.', 'type' => 'string', 'required' => true, 'example' => '0'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Request response result.', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'C2B2F8CF-3074-5BBC-891A-AAD292E2624F', - ], - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3528160969****', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C2B2F8CF-3074-5BBC-891A-AAD292E2624F'], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3528160969****', 'title' => ''], ], 'example' => '', ], @@ -8139,188 +4154,56 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'VerifyExpressionError', - 'errorMessage' => 'Dynamic expression is invalid.', - 'description' => 'Dynamic expression is invalid.', - ], - [ - 'errorCode' => 'InvalidValOfDelHeader', - 'errorMessage' => 'The delete header operation does not support setting value.', - 'description' => 'The delete header operation does not support setting value.', - ], - [ - 'errorCode' => 'SiteFunction.WafPageNotExist', - 'errorMessage' => 'The custom page referenced in the custom response code configuration does not exist.', - 'description' => 'The custom page referenced in the custom response code configuration does not exist.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['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' => '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.'], + ['errorCode' => 'VerifyExpressionError', 'errorMessage' => 'Dynamic expression is invalid.', 'description' => 'Dynamic expression is invalid.'], + ['errorCode' => 'InvalidValOfDelHeader', 'errorMessage' => 'The delete header operation does not support setting value.', 'description' => 'The delete header operation does not support setting value.'], + ['errorCode' => 'SiteFunction.WafPageNotExist', 'errorMessage' => 'The custom page referenced in the custom response code configuration does not exist.', 'description' => 'The custom page referenced in the custom response code configuration does not exist.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'CreateCustomResponseCodeRule', + 'title' => 'Create a custom response code rule', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomResponseCodeRule'], + ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C2B2F8CF-3074-5BBC-891A-AAD292E2624F\\",\\n \\"ConfigId\\": 0\\n}","type":"json"}]', ], 'CreateCustomScenePolicy' => [ - 'summary' => 'Create a user-level scenario-specific policy and associate it with sites to execute the corresponding policy.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Creates a user-level custom scene policy. After you associate the policy with one or more sites, the policy applies to those sites.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8333,156 +4216,84 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239252', - 'abilityTreeNodes' => [ - 'FEATUREdcdnL8HX1L', - ], + 'abilityTreeNodes' => ['FEATUREdcdnL8HX1L'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The policy name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - 'maxLength' => 255, - 'title' => '', - ], + 'schema' => ['description' => 'The policy name.', 'type' => 'string', 'required' => true, 'maxLength' => 255, 'example' => 'test', 'title' => ''], ], [ 'name' => 'Template', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the policy template. Valid value:'."\n" + 'description' => 'The template name. Valid value:'."\n" ."\n" - .'* **promotion**: major events.'."\n", + .'- **promotion**: a policy for major events.', 'type' => 'string', 'required' => true, + 'enum' => ['promotion'], 'example' => 'promotion', - 'enum' => [ - 'promotion', - ], 'title' => '', ], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the policy takes effect.'."\n" - ."\n" - .'The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2021-11-07T17:00:00Z', - 'title' => '', - ], + 'schema' => ['description' => 'The policy start time.'."\n" + ."\n" + .'The time must be in UTC and in ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`.', 'type' => 'string', 'required' => true, 'example' => '2021-11-07T17:00:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the policy expires.'."\n" - ."\n" - .'The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2021-11-07T18:00:00Z', - 'title' => '', - ], + 'schema' => ['description' => 'The policy end time.'."\n" + ."\n" + .'The time must be in UTC and in ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`.', 'type' => 'string', 'required' => true, 'example' => '2021-11-07T18:00:00Z', 'title' => ''], ], [ 'name' => 'Objects', 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the websites that you want to associate with the policy. Separate multiple IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7096621098****,7096621099****'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The IDs of the sites to associate with the policy. Separate multiple site IDs with commas.'."\n" + ."\n" + .'> This parameter is deprecated. Use `SiteIds` instead. If `SiteIds` is specified, the value of this parameter is ignored. To prevent ambiguity, specify a value for either `SiteIds` or `Objects`.', 'type' => 'string', 'required' => false, 'example' => '7096621098****,7096621099****'."\n", 'title' => ''], ], [ 'name' => 'SiteIds', 'in' => 'query', - 'schema' => [ - 'description' => 'Site IDs to associate. Separate multiple site IDs with English commas (",").', - 'type' => 'string', - 'required' => false, - 'example' => '7096621098****,7096621099****'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The IDs of the sites to associate with the policy. Separate multiple site IDs with commas.', 'type' => 'string', 'required' => false, 'example' => '7096621098****,7096621099****'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - ], - 'Name' => [ - 'description' => 'The policy name.'."\n", - 'type' => 'string', - 'example' => 'test', - 'title' => '', - ], - 'Template' => [ - 'description' => 'The name of the policy template.'."\n", - 'type' => 'string', - 'example' => 'promotion', - 'title' => '', - ], - 'StartTime' => [ - 'description' => 'The time when the policy takes effect.'."\n" - ."\n" - .'The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2021-11-07T17:00:00Z', - 'title' => '', - ], - 'EndTime' => [ - 'description' => 'The time when the policy expires.'."\n" - ."\n" - .'The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2021-11-07T18:00:00Z', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9'], + 'Name' => ['description' => 'The policy name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Template' => ['description' => 'The template name.', 'type' => 'string', 'example' => 'promotion', 'title' => ''], + 'StartTime' => ['description' => 'The policy start time.'."\n" + ."\n" + .'The time must be in UTC and in ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`.', 'type' => 'string', 'example' => '2021-11-07T17:00:00Z', 'title' => ''], + 'EndTime' => ['description' => 'The policy end time.'."\n" + ."\n" + .'The time must be in UTC and in ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`.', 'type' => 'string', 'example' => '2021-11-07T18:00:00Z', 'title' => ''], 'Objects' => [ - 'description' => 'The IDs of websites associated.'."\n", + 'description' => 'A list of associated site IDs.'."\n" + ."\n" + .'> This field is deprecated. Read the value from the `SiteIds` field instead.', 'type' => 'array', - 'items' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'string', - 'example' => '7096621098****', - 'title' => '', - ], + 'items' => ['description' => 'The site ID.', 'type' => 'string', 'example' => '7096621098****', 'title' => ''], 'enumValueTitles' => [], 'title' => '', 'example' => '', ], - 'PolicyId' => [ - 'description' => 'The policy ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'title' => '', - ], - 'SiteIds' => [ - 'description' => 'Associated site IDs. Separate multiple site IDs with commas (",").', - 'type' => 'string', - 'example' => '7096621098****, 7096621099****', - 'title' => '', - ], + 'PolicyId' => ['description' => 'The policy ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'SiteIds' => ['description' => 'The associated site IDs, separated by commas.', 'type' => 'string', 'example' => '7096621098****, 7096621099****', 'title' => ''], ], 'example' => '', ], @@ -8490,53 +4301,23 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'PolicyNameExist', - 'errorMessage' => 'The policy name already exists.', - 'description' => 'Policy name already exists.', - ], - [ - 'errorCode' => 'CreateTimeError', - 'errorMessage' => 'The effective time of the same policy template cannot overlap.', - 'description' => 'The effective time of the same policy template cannot overlap.', - ], - [ - 'errorCode' => 'ScenePolicyQuotaExceedLimit', - 'errorMessage' => 'The maximum number of scenario policies has been reached. Each account can create up to 10 scenario policies.', - 'description' => 'The maximum number of scenario policies has been reached. Each account can create up to 10 scenario policies.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'PolicyNameExist', 'errorMessage' => 'The policy name already exists.', 'description' => 'Policy name already exists.'], + ['errorCode' => 'CreateTimeError', 'errorMessage' => 'The effective time of the same policy template cannot overlap.', 'description' => 'The effective time of the same policy template cannot overlap.'], + ['errorCode' => 'ScenePolicyQuotaExceedLimit', 'errorMessage' => 'The maximum number of scenario policies has been reached. Each account can create up to 10 scenario policies.', 'description' => 'The maximum number of scenario policies has been reached. Each account can create up to 10 scenario policies.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Create Scenario-specific Policy', 'changeSet' => [ - [ - 'createdAt' => '2025-06-03T09:31:40.000Z', - 'description' => 'Request parameters changed, Response parameters changed', - ], + ['createdAt' => '2025-06-03T09:31:40.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateCustomScenePolicy', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomScenePolicy'], ], ], 'ramActions' => [ @@ -8547,12 +4328,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -8561,13 +4337,8 @@ ], 'CreateEdgeContainerApp' => [ 'summary' => 'Creates a containerized application. You can deploy and release a version of the application across points of presence (POPs).', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8579,195 +4350,92 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239242', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the application. The name must start with a lowercase letter and can contain lowercase letters, digits, and hyphens (-). The name must be 6 to 128 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'app-test', - 'maxLength' => 128, - 'minLength' => 6, - 'title' => '', - ], + 'schema' => ['description' => 'The name of the application. The name must start with a lowercase letter and can contain lowercase letters, digits, and hyphens (-). The name must be 6 to 128 characters in length.'."\n", 'type' => 'string', 'required' => true, 'example' => 'app-test', 'maxLength' => 128, 'minLength' => 6, 'title' => ''], ], [ 'name' => 'ServicePort', 'in' => 'formData', - 'schema' => [ - 'description' => 'The server port. Valid values: 1 to 65535.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '443', - 'minimum' => '80', - 'example' => '80', - 'title' => '', - ], + 'schema' => ['description' => 'The server port. Valid values: 1 to 65535.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '443', 'minimum' => '80', 'example' => '80', 'title' => ''], ], [ 'name' => 'TargetPort', 'in' => 'formData', - 'schema' => [ - 'description' => 'The backend port, which is also the service port of the application. Valid values: 1 to 65535.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '65535', - 'minimum' => '1', - 'example' => '80', - 'title' => '', - ], + 'schema' => ['description' => 'The backend port, which is also the service port of the application. Valid values: 1 to 65535.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '65535', 'minimum' => '1', 'example' => '80', 'title' => ''], ], [ 'name' => 'Remarks', 'in' => 'formData', - 'schema' => [ - 'description' => 'The remarks. This parameter is empty by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test app', - 'maxLength' => 1024, - 'title' => '', - ], + 'schema' => ['description' => 'The remarks. This parameter is empty by default.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test app', 'maxLength' => 1024, 'title' => ''], ], [ 'name' => 'HealthCheckType', 'in' => 'formData', - 'schema' => [ - 'description' => 'The health check type. By default, this parameter is left empty.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* **l4**: Layer 4 health check.'."\n" - .'* **l7**: Layer 7 health check.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'l7', - 'default' => 'l7', - 'title' => '', - ], + 'schema' => ['description' => 'The health check type. By default, this parameter is left empty.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **l4**: Layer 4 health check.'."\n" + .'* **l7**: Layer 7 health check.'."\n", 'type' => 'string', 'required' => false, 'example' => 'l7', 'default' => 'l7', 'title' => ''], ], [ 'name' => 'HealthCheckHost', 'in' => 'formData', - 'schema' => [ - 'description' => 'The domain name that is used for health checks. This parameter is empty by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.aliyun.com', - 'title' => '', - ], + 'schema' => ['description' => 'The domain name that is used for health checks. This parameter is empty by default.'."\n", 'type' => 'string', 'required' => false, 'example' => 'www.aliyun.com', 'title' => ''], ], [ 'name' => 'HealthCheckHttpCode', 'in' => 'formData', - 'schema' => [ - 'description' => 'The HTTP status code returned for a successful health check. Valid values:'."\n" - ."\n" - .'* **http\\_2xx** (default)'."\n" - .'* **http\\_3xx**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http_2xx', - 'default' => 'http_2xx', - 'title' => '', - ], + 'schema' => ['description' => 'The HTTP status code returned for a successful health check. Valid values:'."\n" + ."\n" + .'* **http\\_2xx** (default)'."\n" + .'* **http\\_3xx**'."\n", 'type' => 'string', 'required' => false, 'example' => 'http_2xx', 'default' => 'http_2xx', 'title' => ''], ], [ 'name' => 'HealthCheckMethod', 'in' => 'formData', - 'schema' => [ - 'description' => 'The HTTP request method for health checks. Valid values:'."\n" - ."\n" - .'* **HEAD** (default): requests the headers of the resource.'."\n" - .'* **GET**: requests the specified resource and returns both the headers and entity body.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HEAD', - 'default' => 'HEAD', - 'title' => '', - ], + 'schema' => ['description' => 'The HTTP request method for health checks. Valid values:'."\n" + ."\n" + .'* **HEAD** (default): requests the headers of the resource.'."\n" + .'* **GET**: requests the specified resource and returns both the headers and entity body.'."\n", 'type' => 'string', 'required' => false, 'example' => 'HEAD', 'default' => 'HEAD', 'title' => ''], ], [ 'name' => 'HealthCheckURI', 'in' => 'formData', - 'schema' => [ - 'description' => 'The URI used for health checks. The URI must be **1** to **80** characters in length. Default value: "/".'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/health_check', - 'title' => '', - ], + 'schema' => ['description' => 'The URI used for health checks. The URI must be **1** to **80** characters in length. Default value: "/".'."\n", 'type' => 'string', 'required' => false, 'example' => '/health_check', 'title' => ''], ], [ 'name' => 'HealthCheckPort', 'in' => 'formData', - 'schema' => [ - 'description' => 'The port used for health checks. Valid values: 1 to 65535. Default value: 80.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '80', - 'title' => '', - ], + 'schema' => ['description' => 'The port used for health checks. Valid values: 1 to 65535. Default value: 80.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80', 'title' => ''], ], [ 'name' => 'HealthCheckTimeout', 'in' => 'formData', - 'schema' => [ - 'description' => 'The timeout period of a health check response. If a backend ECS instance does not respond within the specified timeout period, the ECS instance fails the health check. Unit: seconds.\\'."\n" - .'Valid values: **1** to **100**.\\'."\n" - .'Default value: **3**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - 'title' => '', - ], + 'schema' => ['description' => 'The timeout period of a health check response. If a backend ECS instance does not respond within the specified timeout period, the ECS instance fails the health check. Unit: seconds.\\'."\n" + .'Valid values: **1** to **100**.\\'."\n" + .'Default value: **3**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], ], [ 'name' => 'HealthCheckInterval', 'in' => 'formData', - 'schema' => [ - 'description' => 'The interval between two consecutive health checks. Unit: seconds. Valid values: **1** to **50**. Default value: **5**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - 'title' => '', - ], + 'schema' => ['description' => 'The interval between two consecutive health checks. Unit: seconds. Valid values: **1** to **50**. Default value: **5**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], ], [ 'name' => 'HealthCheckSuccTimes', 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of consecutive successful health checks required for an application to be considered as healthy. Valid values: 1 to 10. Default value: 2.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - 'title' => '', - ], + 'schema' => ['description' => 'The number of consecutive successful health checks required for an application to be considered as healthy. Valid values: 1 to 10. Default value: 2.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'HealthCheckFailTimes', 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of consecutive failed health checks required for an application to be considered as unhealthy. Valid values: 1 to 10. Default value: 5.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - 'title' => '', - ], + 'schema' => ['description' => 'The number of consecutive failed health checks required for an application to be considered as unhealthy. Valid values: 1 to 10. Default value: 5.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], ], ], 'responses' => [ @@ -8776,18 +4444,8 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'AppId' => [ - 'description' => 'The ID of the application that is created.'."\n", - 'type' => 'string', - 'example' => 'app-880688675783794688', - 'title' => '', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - 'title' => '', - ], + 'AppId' => ['description' => 'The ID of the application that is created.'."\n", 'type' => 'string', 'example' => 'app-880688675783794688', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', 'title' => ''], ], 'title' => '', 'example' => '', @@ -8796,95 +4454,27 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.HealthCheckType', - 'errorMessage' => 'Specified parameter HealthCheckType is not valid.', - 'description' => 'Parameter HealthCheckType format is incorrect.', - ], - [ - 'errorCode' => 'InvalidParameter.HealthCheckHost', - 'errorMessage' => 'Specified parameter HealthCheckHost is not valid.', - 'description' => 'Parameter HealthCheckHost format is incorrect.', - ], - [ - 'errorCode' => 'InvalidParameter.HealthCheckHttpCode', - 'errorMessage' => 'Specified parameter HealthCheckHttpCode is not valid.', - 'description' => 'Parameter HealthCheckHttpCode format is incorrect.', - ], - [ - 'errorCode' => 'InvalidParameter.HealthCheckMethod', - 'errorMessage' => 'Specified parameter HealthCheckMethod is not valid.', - 'description' => 'Parameter HealthCheckMethod format is incorrect.', - ], - [ - 'errorCode' => 'InvalidParameter.HealthCheckURI', - 'errorMessage' => 'Specified parameter HealthCheckURI is not valid.', - 'description' => 'Parameter HealthCheckURI format is incorrect.', - ], - [ - 'errorCode' => 'InvalidParameter.HealthCheckInterval', - 'errorMessage' => 'Specified parameter HealthCheckInterval is not valid.', - 'description' => 'Parameter HealthCheckInterval format is incorrect.', - ], - [ - 'errorCode' => 'InvalidParameter.HealthCheckTimeout', - 'errorMessage' => 'Specified parameter HealthCheckTimeout is not valid.', - 'description' => 'Parameter HealthCheckTimeout format is incorrect.', - ], - [ - 'errorCode' => 'InvalidParameter.HealthCheckSuccTimes', - 'errorMessage' => 'Specified parameter HealthCheckSuccTimes is not valid.', - 'description' => 'Parameter HealthCheckHost format is incorrect.', - ], - [ - 'errorCode' => 'InvalidParameter.HealthCheckFailTimes', - 'errorMessage' => 'Specified parameter HealthCheckFailTimes is not valid.', - 'description' => 'Parameter HealthCheckFailTimes format is incorrect.', - ], - [ - 'errorCode' => 'InvalidParameter.HealthCheckPort', - 'errorMessage' => 'Specified parameter HealthCheckPort is not valid.', - 'description' => 'Parameter HealthCheckPort format is incorrect.', - ], - [ - 'errorCode' => 'InvalidParameter.PageNumber', - 'errorMessage' => 'Failed to verify parameter PageNumber.Check whether the parameter exists and is set to a positive integer.', - 'description' => 'Failed to verify parameter PageNumber.Check whether the parameter exists and is set to a positive integer.', - ], - [ - 'errorCode' => 'InvalidParameter.appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'NameAlreadyExists', - 'errorMessage' => 'The name already exists.', - 'description' => 'Name already exists.', - ], - [ - 'errorCode' => 'ParamNameError', - 'errorMessage' => 'The Name parameter is invalid.', - 'description' => 'The Name parameter is illegal.'."\n", - ], + ['errorCode' => 'InvalidParameter.HealthCheckType', 'errorMessage' => 'Specified parameter HealthCheckType is not valid.', 'description' => 'Parameter HealthCheckType format is incorrect.'], + ['errorCode' => 'InvalidParameter.HealthCheckHost', 'errorMessage' => 'Specified parameter HealthCheckHost is not valid.', 'description' => 'Parameter HealthCheckHost format is incorrect.'], + ['errorCode' => 'InvalidParameter.HealthCheckHttpCode', 'errorMessage' => 'Specified parameter HealthCheckHttpCode is not valid.', 'description' => 'Parameter HealthCheckHttpCode format is incorrect.'], + ['errorCode' => 'InvalidParameter.HealthCheckMethod', 'errorMessage' => 'Specified parameter HealthCheckMethod is not valid.', 'description' => 'Parameter HealthCheckMethod format is incorrect.'], + ['errorCode' => 'InvalidParameter.HealthCheckURI', 'errorMessage' => 'Specified parameter HealthCheckURI is not valid.', 'description' => 'Parameter HealthCheckURI format is incorrect.'], + ['errorCode' => 'InvalidParameter.HealthCheckInterval', 'errorMessage' => 'Specified parameter HealthCheckInterval is not valid.', 'description' => 'Parameter HealthCheckInterval format is incorrect.'], + ['errorCode' => 'InvalidParameter.HealthCheckTimeout', 'errorMessage' => 'Specified parameter HealthCheckTimeout is not valid.', 'description' => 'Parameter HealthCheckTimeout format is incorrect.'], + ['errorCode' => 'InvalidParameter.HealthCheckSuccTimes', 'errorMessage' => 'Specified parameter HealthCheckSuccTimes is not valid.', 'description' => 'Parameter HealthCheckHost format is incorrect.'], + ['errorCode' => 'InvalidParameter.HealthCheckFailTimes', 'errorMessage' => 'Specified parameter HealthCheckFailTimes is not valid.', 'description' => 'Parameter HealthCheckFailTimes format is incorrect.'], + ['errorCode' => 'InvalidParameter.HealthCheckPort', 'errorMessage' => 'Specified parameter HealthCheckPort is not valid.', 'description' => 'Parameter HealthCheckPort format is incorrect.'], + ['errorCode' => 'InvalidParameter.PageNumber', 'errorMessage' => 'Failed to verify parameter PageNumber.Check whether the parameter exists and is set to a positive integer.', 'description' => 'Failed to verify parameter PageNumber.Check whether the parameter exists and is set to a positive integer.'], + ['errorCode' => 'InvalidParameter.appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'NameAlreadyExists', 'errorMessage' => 'The name already exists.', 'description' => 'Name already exists.'], + ['errorCode' => 'ParamNameError', 'errorMessage' => 'The Name parameter is invalid.', 'description' => 'The Name parameter is illegal.'."\n"], ], 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppId\\": \\"app-880688675783794688\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', @@ -8892,12 +4482,7 @@ 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateEdgeContainerApp', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEdgeContainerApp'], ], ], 'ramActions' => [ @@ -8908,12 +4493,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -8922,12 +4502,8 @@ 'CreateEdgeContainerAppImageSecret' => [ 'summary' => 'Create an image secret for the edge container application', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -8939,54 +4515,28 @@ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'Application ID, which can be obtained using the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) interface.', - 'type' => 'string', - 'required' => true, - 'example' => 'app-88068867578379****', - 'title' => '', - ], + 'schema' => ['description' => 'Application ID, which can be obtained using the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) interface.', 'type' => 'string', 'required' => true, 'example' => 'app-88068867578379****', 'title' => ''], ], [ 'name' => 'Registry', 'in' => 'query', - 'schema' => [ - 'description' => 'Image repository address.', - 'type' => 'string', - 'required' => true, - 'example' => 'cr-cn-shanghai.edas.aliyuncs.com', - 'title' => '', - ], + 'schema' => ['description' => 'Image repository address.', 'type' => 'string', 'required' => true, 'example' => 'cr-cn-shanghai.edas.aliyuncs.com', 'title' => ''], ], [ 'name' => 'Username', 'in' => 'query', - 'schema' => [ - 'description' => 'Image repository username.', - 'type' => 'string', - 'required' => true, - 'example' => 'admin', - 'title' => '', - ], + 'schema' => ['description' => 'Image repository username.', 'type' => 'string', 'required' => true, 'example' => 'admin', 'title' => ''], ], [ 'name' => 'Password', 'in' => 'query', - 'schema' => [ - 'description' => 'Image repository password.', - 'type' => 'string', - 'required' => true, - 'example' => '***', - 'title' => '', - ], + 'schema' => ['description' => 'Image repository password.', 'type' => 'string', 'required' => true, 'example' => '***', 'title' => ''], ], ], 'responses' => [ @@ -8996,12 +4546,7 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE'], ], 'example' => '', ], @@ -9009,38 +4554,16 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', - 'description' => 'Invalid parameter. Check the parameter configuration.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], - [ - 'errorCode' => 'InvalidParameter.Appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the input application ID is incorrect. You can use the ListEdgeContainerApps API to obtain the application ID.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', 'description' => 'Invalid parameter. Check the parameter configuration.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['errorCode' => 'InvalidParameter.Appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the input application ID is incorrect. You can use the ListEdgeContainerApps API to obtain the application ID.'], ], 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Create Edge Container Application Image Secret', 'changeSet' => [], 'flowControl' => [ @@ -9051,13 +4574,8 @@ ], 'CreateEdgeContainerAppRecord' => [ 'summary' => 'Associates a domain name with a containerized application. This way, requests destined for the associated domain name are forwarded to the application.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9069,47 +4587,23 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239304', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'app-88068867578379****', - 'maxLength' => 64, - 'minLength' => 20, - 'title' => '', - ], + 'schema' => ['description' => 'The application ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'app-88068867578379****', 'maxLength' => 64, 'minLength' => 20, 'title' => ''], ], [ 'name' => 'SiteId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5407498413****', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5407498413****', 'title' => ''], ], [ 'name' => 'RecordName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The associated domain name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a.example.com', - 'maxLength' => 1024, - 'title' => '', - ], + 'schema' => ['description' => 'The associated domain name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'a.example.com', 'maxLength' => 1024, 'title' => ''], ], ], 'responses' => [ @@ -9117,12 +4611,7 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', 'title' => ''], ], 'description' => '', 'title' => '', @@ -9132,35 +4621,15 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - ], - [ - 'errorCode' => 'ParameterAlreadyExist', - 'errorMessage' => 'Parameter uniqueness verification failed. Check for duplicate parameter values.', - 'description' => 'Parameter uniqueness verification failed. Check for duplicate parameter values.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InvalidParameter.appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.'], + ['errorCode' => 'ParameterAlreadyExist', 'errorMessage' => 'Parameter uniqueness verification failed. Check for duplicate parameter values.', 'description' => 'Parameter uniqueness verification failed. Check for duplicate parameter values.'], ], 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', @@ -9168,12 +4637,7 @@ 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateEdgeContainerAppRecord', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEdgeContainerAppRecord'], ], ], 'ramActions' => [ @@ -9184,12 +4648,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -9201,13 +4660,8 @@ ], 'CreateEdgeContainerAppVersion' => [ 'summary' => 'Creates a version for a containerized application. You can iterate the application based on the version.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9219,304 +4673,88 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239192', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'app-88068867578379****', - 'maxLength' => 64, - 'minLength' => 20, - 'title' => '', - ], + 'schema' => ['description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 20, 'example' => 'app-88068867578379****', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The version name, which must be 6 to 128 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'verson1', - 'maxLength' => 128, - 'minLength' => 6, - 'title' => '', - ], + 'schema' => ['description' => 'The version name, which must be 6 to 128 characters in length.', 'type' => 'string', 'required' => true, 'maxLength' => 128, 'minLength' => 6, 'example' => 'verson1', 'title' => ''], ], [ 'name' => 'Remarks', 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the version.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test app', - 'maxLength' => 1024, - 'title' => '', - ], + 'schema' => ['description' => 'The description of the version.', 'type' => 'string', 'required' => false, 'maxLength' => 1024, 'example' => 'test app', 'title' => ''], ], [ 'name' => 'Containers', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The container group to be deployed for this version, which contains information about images.\\'."\n" - .'The image data contains the image address, startup command, parameters, environment variables, and probe rules. You can specify one or more images. The parameter value is a JSON string.'."\n", + 'description' => 'The container group to be deployed for this version, which contains information about images.
The image data contains the image address, startup command, parameters, environment variables, and probe rules. You can specify one or more images. The parameter value is a JSON string.', 'type' => 'array', 'items' => [ - 'description' => 'The details of the container.'."\n", + 'description' => 'The details of the container.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the container. The name must be unique in the same container group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'lxg-demo-er', - 'title' => '', - ], - 'Image' => [ - 'description' => 'The address of the image.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'registry-vpc.cn-shenzhen.aliyuncs.com/lihe****h/ea****ts_serv****am:3.**', - 'title' => '', - ], - 'IsACRImage' => [ - 'description' => 'Specifies whether the image is a Container Registry image.'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - 'title' => '', - ], + 'Name' => ['description' => 'The name of the container. The name must be unique in the same container group.', 'type' => 'string', 'required' => true, 'example' => 'lxg-demo-er', 'title' => ''], + 'Image' => ['description' => 'The address of the image.', 'type' => 'string', 'required' => true, 'example' => 'registry-vpc.cn-shenzhen.aliyuncs.com/lihe****h/ea****ts_serv****am:3.**', 'title' => ''], + 'IsACRImage' => ['description' => 'Specifies whether the image is a Container Registry image.', 'type' => 'boolean', 'required' => true, 'example' => 'false', 'title' => ''], 'ACRImageInfo' => [ - 'description' => 'The information about the Container Registry image.'."\n", + 'description' => 'The information about the Container Registry image.', 'type' => 'object', 'properties' => [ - 'IsEnterpriseRegistry' => [ - 'description' => 'Specifies whether the image is an enterprise-level Container Registry image.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'title' => '', - ], - 'Domain' => [ - 'description' => 'The domain name of the Container Registry image.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1500.***.net', - 'title' => '', - ], - 'InstanceId' => [ - 'description' => 'The ID of the Container Registry instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xcdn-9axbo****', - 'title' => '', - ], - 'RegionId' => [ - 'description' => 'The regions in which the Container Registry instance resides.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai', - 'title' => '', - ], - 'RepoId' => [ - 'description' => 'The ID of the image repository.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'crr-h1ghghu60ct****', - 'title' => '', - ], - 'RepoName' => [ - 'description' => 'The name of the image repository.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_71', - 'title' => '', - ], - 'RepoNamespace' => [ - 'description' => 'The namespace to which the image repository belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'safeline', - 'title' => '', - ], - 'Tag' => [ - 'description' => 'The tag of the Container Registry image.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3.40.2', - 'title' => '', - ], - 'TagUrl' => [ - 'description' => 'The URL of the Container Registry image tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'registry-vpc.cn-shenzhen.aliyuncs.com/****/eas***m:31', - 'title' => '', - ], + 'IsEnterpriseRegistry' => ['description' => 'Specifies whether the image is an enterprise-level Container Registry image.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'Domain' => ['description' => 'The domain name of the Container Registry image.', 'type' => 'string', 'required' => false, 'example' => '1500.***.net', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the Container Registry instance.', 'type' => 'string', 'required' => false, 'example' => 'xcdn-9axbo****', 'title' => ''], + 'RegionId' => ['description' => 'The regions in which the Container Registry instance resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], + 'RepoId' => ['description' => 'The ID of the image repository.', 'type' => 'string', 'required' => false, 'example' => 'crr-h1ghghu60ct****', 'title' => ''], + 'RepoName' => ['description' => 'The name of the image repository.', 'type' => 'string', 'required' => false, 'example' => 'test_71', 'title' => ''], + 'RepoNamespace' => ['description' => 'The namespace to which the image repository belongs.', 'type' => 'string', 'required' => false, 'example' => 'safeline', 'title' => ''], + 'Tag' => ['description' => 'The tag of the Container Registry image.', 'type' => 'string', 'required' => false, 'example' => '3.40.2', 'title' => ''], + 'TagUrl' => ['description' => 'The URL of the Container Registry image tag.', 'type' => 'string', 'required' => false, 'example' => 'registry-vpc.cn-shenzhen.aliyuncs.com/****/eas***m:31', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], - 'Spec' => [ - 'description' => 'The compute specification of the container. Valid values: 1C2G, 2C4G, 2C8G, 4C8G, 4C16G, 8C16G, and 8C32G.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1C2G', - 'title' => '', - ], - 'Command' => [ - 'description' => 'The command that is used to start the container. Separate the arguments with spaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'nginx', - 'title' => '', - ], - 'Args' => [ - 'description' => 'The arguments that are passed to the container startup command. Separate the parameters with spaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '-a', - 'title' => '', - ], - 'Storage' => [ - 'description' => 'The storage capacity. Valid values: 0.5G, 10G, 20G, and 30G.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0.5G', - 'title' => '', - ], - 'EnvVariables' => [ - 'description' => 'The environment variables. Separate the environment variables with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'VITE_APP_TITLE=My App', - 'title' => '', - ], - 'PostStart' => [ - 'description' => 'The command that is run before the container is started. Separate the arguments with spaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sh poststart.sh "echo hello world" ', - 'title' => '', - ], - 'PreStop' => [ - 'description' => 'The command that is run before the container is stopped. Separate the arguments with spaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sh prestop.sh "echo hello world" ', - 'title' => '', - ], - 'ProbeType' => [ - 'description' => 'The type of the probe. Valid values:'."\n" - ."\n" - .'* exec: the command type.'."\n" - .'* tcpSocket: the TCP probe type.'."\n" - .'* httpGet: the HTTP access type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'exec', - 'title' => '', - ], + 'Spec' => ['description' => 'The compute specification of the container. Valid values: 1C2G, 2C4G, 2C8G, 4C8G, 4C16G, 8C16G, and 8C32G.', 'type' => 'string', 'required' => true, 'example' => '1C2G', 'title' => ''], + 'Command' => ['description' => 'The command that is used to start the container. Separate the arguments with spaces.', 'type' => 'string', 'required' => false, 'example' => 'nginx', 'title' => ''], + 'Args' => ['description' => 'The arguments that are passed to the container startup command. Separate the parameters with spaces.', 'type' => 'string', 'required' => false, 'example' => '-a', 'title' => ''], + 'Storage' => ['description' => 'The storage capacity. Valid values: 0.5G, 10G, 20G, and 30G.', 'type' => 'string', 'required' => true, 'example' => '0.5G', 'title' => ''], + 'EnvVariables' => ['description' => 'The environment variables. Separate the environment variables with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'VITE_APP_TITLE=My App', 'title' => ''], + 'PostStart' => ['description' => 'The command that is run before the container is started. Separate the arguments with spaces.', 'type' => 'string', 'required' => false, 'example' => 'sh poststart.sh "echo hello world" ', 'title' => ''], + 'PreStop' => ['description' => 'The command that is run before the container is stopped. Separate the arguments with spaces.', 'type' => 'string', 'required' => false, 'example' => 'sh prestop.sh "echo hello world" ', 'title' => ''], + 'ProbeType' => ['description' => 'The type of the probe. Valid values:'."\n" + ."\n" + .'- exec: the command type.'."\n" + ."\n" + .'- tcpSocket: the TCP probe type.'."\n" + ."\n" + .'- httpGet: the HTTP access type.', 'type' => 'string', 'required' => true, 'example' => 'exec', 'title' => ''], 'ProbeContent' => [ - 'description' => 'The content of the container health probe.'."\n", + 'description' => 'The content of the container health probe.', 'type' => 'object', 'properties' => [ - 'InitialDelaySeconds' => [ - 'description' => 'The latency for container probe initialization.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], - 'TimeoutSeconds' => [ - 'description' => 'The timeout period of the container health check.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], - 'PeriodSeconds' => [ - 'description' => 'The interval between container health checks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], - 'SuccessThreshold' => [ - 'description' => 'The number of consecutive successful health checks required for a container to be considered as healthy.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], - 'FailureThreshold' => [ - 'description' => 'The number of consecutive failed health checks required for a container to be considered as unhealthy.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - 'title' => '', - ], - 'Command' => [ - 'title' => '', - 'description' => 'The command of the exec type probe.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'echo ok', - ], - 'Port' => [ - 'description' => 'The health check port.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '9991', - 'title' => '', - ], - 'Host' => [ - 'description' => 'The domain name that is used for health checks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.rewrite.com', - 'title' => '', - ], - 'Path' => [ - 'description' => 'The health check path.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/', - 'title' => '', - ], - 'Scheme' => [ - 'description' => 'The protocol that the container health check request uses.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http', - 'title' => '', - ], - 'HttpHeaders' => [ - 'description' => 'The request headers that are included in the container health check request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{\\"Content-Type\\":\\"application/json\\"}]', - 'title' => '', - ], + 'InitialDelaySeconds' => ['description' => 'The latency for container probe initialization.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'TimeoutSeconds' => ['description' => 'The timeout period of the container health check.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'PeriodSeconds' => ['description' => 'The interval between container health checks.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'SuccessThreshold' => ['description' => 'The number of consecutive successful health checks required for a container to be considered as healthy.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'FailureThreshold' => ['description' => 'The number of consecutive failed health checks required for a container to be considered as unhealthy.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'Command' => ['description' => 'The command of the exec type probe.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'echo ok'], + 'Port' => ['description' => 'The health check port.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '9991', 'title' => ''], + 'Host' => ['description' => 'The domain name that is used for health checks.', 'type' => 'string', 'required' => false, 'example' => 'www.rewrite.com', 'title' => ''], + 'Path' => ['description' => 'The health check path.', 'type' => 'string', 'required' => false, 'example' => '/', 'title' => ''], + 'Scheme' => ['description' => 'The protocol that the container health check request uses.', 'type' => 'string', 'required' => false, 'example' => 'http', 'title' => ''], + 'HttpHeaders' => ['description' => 'The request headers that are included in the container health check request.', 'type' => 'string', 'required' => false, 'example' => '[{\\"Content-Type\\":\\"application/json\\"}]', 'title' => ''], ], 'required' => true, - 'example' => '具体字段可参照k8s官方就绪探针的定义。', + 'example' => 'For details, see the definition of readiness probes in Kubernetes.', 'title' => '', ], ], @@ -9552,18 +4790,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'VersionId' => [ - 'description' => 'The ID of the created version.'."\n", - 'type' => 'string', - 'example' => 'ver-87962637161651****', - 'title' => '', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - 'title' => '', - ], + 'VersionId' => ['description' => 'The ID of the created version.', 'type' => 'string', 'example' => 'ver-87962637161651****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', 'title' => ''], ], 'description' => '', 'title' => '', @@ -9573,60 +4801,20 @@ ], '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' => 'The Name parameter is not valid. Check the Name parameter, which is between 6 and 128 characters. After modification, call the interface again.', - ], - [ - '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' => 'The Percentage parameter is invalid. Check the Percentage parameter. The parameter range is 1-100. Modify the parameter and call the interface again.', - ], - [ - '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' => 'Illegal Image parameter. Please check the Image parameter, which cannot be assigned to illegal characters such @.', - ], - [ - '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' => 'The HttpHeaders parameter is invalid. Please check whether the HttpHeaders parameter is filled in. The parameter cannot contain @.', - ], - [ - 'errorCode' => 'InvalidParameter.appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'ParameterAlreadyExist', - 'errorMessage' => 'Parameter uniqueness verification failed. Check for duplicate parameter values.', - 'description' => 'Parameter uniqueness verification failed. Check for duplicate parameter values.', - ], - [ - 'errorCode' => 'NameAlreadyExists', - 'errorMessage' => 'The name already exists.', - 'description' => 'Name already exists.', - ], + ['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' => 'The Name parameter is not valid. Check the Name parameter, which is between 6 and 128 characters. After modification, call the interface again.'], + ['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' => 'The Percentage parameter is invalid. Check the Percentage parameter. The parameter range is 1-100. Modify the parameter and call the interface again.'], + ['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' => 'Illegal Image parameter. Please check the Image parameter, which cannot be assigned to illegal characters such @.'], + ['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' => 'The HttpHeaders parameter is invalid. Please check whether the HttpHeaders parameter is filled in. The parameter cannot contain @.'], + ['errorCode' => 'InvalidParameter.appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'ParameterAlreadyExist', 'errorMessage' => 'Parameter uniqueness verification failed. Check for duplicate parameter values.', 'description' => 'Parameter uniqueness verification failed. Check for duplicate parameter values.'], + ['errorCode' => 'NameAlreadyExists', 'errorMessage' => 'The name already exists.', 'description' => 'Name already exists.'], ], 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], 'eventInfo' => [ @@ -9638,12 +4826,7 @@ 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateEdgeContainerAppVersion', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEdgeContainerAppVersion'], ], ], 'ramActions' => [ @@ -9654,24 +4837,17 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], + 'translator' => 'manual', ], 'CreateHttpIncomingRequestHeaderModificationRule' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Creates a configuration for modifying HTTP inbound request headers for a site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -9684,60 +4860,35 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257646', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '478016908379824', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '478016908379824', 'title' => ''], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version on which the configuration takes effect. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'The rule name. You do not need to set this parameter when you add global configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. This parameter is not required when you add a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", + 'description' => 'The rule switch. This parameter is not required when you add a global configuration. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, - 'enum' => [ - 'on', - 'off', - ], 'example' => 'on', 'title' => '', ], @@ -9745,69 +4896,44 @@ [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:'."\n" - ."\n" - .'* true: Match all incoming requests.'."\n" - .'* Set the value to a custom expression, for example: (http.host eq "video.example.com"): Match the specified request'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], + 'schema' => ['description' => 'The rule content, which uses a conditional expression to match user requests. This parameter is not required when you add a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: set the value to true.'."\n" + .'- Match specified requests: set the value to a custom expression, such as (http.host eq \\"video.example.com\\").', 'type' => 'string', 'required' => false, 'example' => '(http.host eq "video.example.com")', 'title' => ''], ], [ 'name' => 'RequestHeaderModification', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The configurations of modifying request headers. You can add, delete, or modify a request header.'."\n", + 'description' => 'The request header modifications. Three operations are supported: add, delete, and modify.', 'type' => 'array', 'items' => [ - 'description' => 'The configuration of modifying a request header.'."\n", + 'description' => 'The request header modification details.', 'type' => 'object', 'properties' => [ 'Operation' => [ - 'description' => 'The action. Valid values:'."\n" + 'description' => 'The operation type. Valid values:'."\n" ."\n" - .'* add: adds a response header.'."\n" - .'* del: deletes a response header.'."\n" - .'* modify: modifies a response header.'."\n", + .'- add: adds a request header.'."\n" + .'- del: deletes a request header.'."\n" + .'- modify: modifies a request header.', + 'enumValueTitles' => ['add' => '添加', 'modify' => '变更', 'del' => '删除'], 'type' => 'string', 'required' => true, - 'enum' => [ - 'add', - 'modify', - 'del', - ], + 'enum' => ['add', 'modify', 'del'], 'example' => 'add', 'title' => '', ], - 'Name' => [ - 'description' => 'The name of the request header.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'headername'."\n", - 'title' => '', - ], - 'Value' => [ - 'description' => 'The value of the request header.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'headvalue', - 'title' => '', - ], + 'Name' => ['description' => 'The request header name.', 'type' => 'string', 'required' => true, 'example' => 'headername'."\n", 'title' => ''], + 'Value' => ['description' => 'The request header value.', 'type' => 'string', 'required' => false, 'example' => 'headvalue', 'title' => ''], 'Type' => [ - 'description' => 'The type of the value. Valid values:'."\n" - ."\n" - .'* static'."\n" - .'* dynamic'."\n", + 'description' => 'The value type. Valid values:'."\n" + .'- static: static pattern.'."\n" + .'- dynamic: dynamic pattern.', + 'enumValueTitles' => ['static' => '静态模式', 'dynamic' => '动态模式'], 'type' => 'string', + 'enum' => ['static', 'dynamic'], 'required' => false, - 'enum' => [ - 'static', - 'dynamic', - ], 'example' => 'static', 'title' => '', ], @@ -9824,36 +4950,18 @@ [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'The order in which the rule is executed. A smaller value gives priority to the rule.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7C414690-9D7B-5D66-9CD9-AD0B3F25ED49', - ], - 'ConfigId' => [ - 'description' => 'The configuration ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '35281609698****', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7C414690-9D7B-5D66-9CD9-AD0B3F25ED49'], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '35281609698****', 'title' => ''], ], 'example' => '', ], @@ -9861,182 +4969,55 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'VerifyExpressionError', - 'errorMessage' => 'Dynamic expression is invalid.', - 'description' => 'Dynamic expression is invalid.', - ], - [ - 'errorCode' => 'InvalidValOfDelHeader', - 'errorMessage' => 'The delete header operation does not support setting value.', - 'description' => 'The delete header operation does not support setting value.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['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' => '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.'], + ['errorCode' => 'VerifyExpressionError', 'errorMessage' => 'Dynamic expression is invalid.', 'description' => 'Dynamic expression is invalid.'], + ['errorCode' => 'InvalidValOfDelHeader', 'errorMessage' => 'The delete header operation does not support setting value.', 'description' => 'The delete header operation does not support setting value.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'CreateHttpIncomingRequestHeaderModificationRule', - 'summary' => 'Adds the configuration of modifying HTTP request headers for a website.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C414690-9D7B-5D66-9CD9-AD0B3F25ED49\\",\\n \\"ConfigId\\": 0\\n}","type":"json"}]', + 'title' => 'Create an HTTP inbound request header modification configuration', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHttpIncomingRequestHeaderModificationRule'], + ], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C414690-9D7B-5D66-9CD9-AD0B3F25ED49\\",\\n \\"ConfigId\\": 0\\n}","type":"json"}]', ], 'CreateHttpIncomingResponseHeaderModificationRule' => [ - 'summary' => 'Adds the configuration of modifying HTTP response headers for a website.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Creates a configuration for modifying HTTP inbound response headers for a site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -10049,60 +5030,35 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257651', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '608665779308176', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '608665779308176', 'title' => ''], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version on which the configuration takes effect. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'The rule name. You do not need to set this parameter when you add global configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. You do not need to set this parameter when you add a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", + 'description' => 'The rule switch. You do not need to set this parameter when you add a global configuration. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', 'required' => false, - 'enum' => [ - 'on', - 'off', - ], + 'enum' => ['on', 'off'], 'example' => 'on', 'title' => '', ], @@ -10110,69 +5066,44 @@ [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:'."\n" - ."\n" - .'* true: Match all incoming requests.'."\n" - .'* Set the value to a custom expression, for example: (http.host eq "video.example.com"): Match the specified request'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], + 'schema' => ['description' => 'The rule content, which uses a conditional expression to match user requests. You do not need to set this parameter when you add a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: set the value to true.'."\n" + .'- Match specified requests: set the value to a custom expression, such as (http.host eq \\"video.example.com\\").', 'type' => 'string', 'required' => false, 'example' => '(http.host eq "video.example.com")', 'title' => ''], ], [ 'name' => 'ResponseHeaderModification', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The configurations of modifying response headers. You can add, delete, or modify a response header.'."\n", + 'description' => 'The response header modifications. Three operation types are supported: add, delete, and modify.', 'type' => 'array', 'items' => [ - 'description' => 'The configuration of modifying a response header.'."\n", + 'description' => 'The response header modification details.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the response header.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'headerName', - 'title' => '', - ], + 'Name' => ['description' => 'The response header name.', 'type' => 'string', 'required' => true, 'example' => 'headerName', 'title' => ''], 'Operation' => [ - 'description' => 'The action. Valid values:'."\n" + 'description' => 'The operation type. Valid values:'."\n" ."\n" - .'* add: adds a response header.'."\n" - .'* del: deletes a response header.'."\n" - .'* modify: modifies a response header.'."\n", + .'- add: adds a response header.'."\n" + .'- del: deletes a response header.'."\n" + .'- modify: modifies a response header.', + 'enumValueTitles' => ['add' => '添加', 'modify' => '变更', 'del' => '删除'], 'type' => 'string', 'required' => true, - 'enum' => [ - 'add', - 'modify', - 'del', - ], + 'enum' => ['add', 'modify', 'del'], 'example' => 'add', 'title' => '', ], - 'Value' => [ - 'description' => 'The value of the response header.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'headerValue', - 'title' => '', - ], + 'Value' => ['description' => 'The response header value.', 'type' => 'string', 'required' => false, 'example' => 'headerValue', 'title' => ''], 'Type' => [ - 'description' => 'The type of the value. Valid values:'."\n" - ."\n" - .'* static'."\n" - .'* dynamic'."\n", + 'description' => 'The value type. Valid values:'."\n" + .'- static: static pattern.'."\n" + .'- dynamic: dynamic pattern.', + 'enumValueTitles' => ['static' => '静态模式', 'dynamic' => '动态模式'], 'type' => 'string', + 'enum' => ['static', 'dynamic'], 'required' => false, - 'enum' => [ - 'static', - 'dynamic', - ], 'example' => 'static', 'title' => '', ], @@ -10189,36 +5120,18 @@ [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'The order in which the rule is executed. A smaller value gives priority to the rule.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792', - ], - 'ConfigId' => [ - 'description' => 'The configuration ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '434497172875264', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792'], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '434497172875264', 'title' => ''], ], 'example' => '', ], @@ -10226,181 +5139,55 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'VerifyExpressionError', - 'errorMessage' => 'Dynamic expression is invalid.', - 'description' => 'Dynamic expression is invalid.', - ], - [ - 'errorCode' => 'InvalidValOfDelHeader', - 'errorMessage' => 'The delete header operation does not support setting value.', - 'description' => 'The delete header operation does not support setting value.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['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' => '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.'], + ['errorCode' => 'VerifyExpressionError', 'errorMessage' => 'Dynamic expression is invalid.', 'description' => 'Dynamic expression is invalid.'], + ['errorCode' => 'InvalidValOfDelHeader', 'errorMessage' => 'The delete header operation does not support setting value.', 'description' => 'The delete header operation does not support setting value.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'CreateHttpIncomingResponseHeaderModificationRule', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"156A6B-677B1A-4297B7-9187B7-2B44792\\",\\n \\"ConfigId\\": 434497172875264\\n}","type":"json"}]', + 'title' => 'Create an HTTP inbound response header modification configuration', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHttpIncomingResponseHeaderModificationRule'], + ], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"156A6B-677B1A-4297B7-9187B7-2B44792\\",\\n \\"ConfigId\\": 434497172875264\\n}","type":"json"}]', ], 'CreateHttpRequestHeaderModificationRule' => [ - 'summary' => 'Add HTTP Request Header Rule', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Adds a Configuration for modifying a Site\'s HTTP Request Headers.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -10413,126 +5200,84 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257646', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '5407498413****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the Site. You can get this ID by calling the [ListSites](~~ListSites~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5407498413****', 'title' => ''], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Version number of the site configuration. For sites with version management enabled, this parameter can specify the version to which the configuration applies, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The Version of the Site configuration. For a Site with configuration versioning enabled, this parameter specifies the configuration\'s target Version. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Rule. This parameter is not required when you add a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example'."\n", 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Possible values:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', + 'description' => 'Specifies whether to enable the Rule. This parameter is not required when you add a global configuration. Valid values are:'."\n" + ."\n" + .'- on: Enables the Rule.'."\n" + ."\n" + .'- off: Disables the Rule.', 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- To match all incoming requests: Set the value to true'."\n" - .'- To match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], + 'schema' => ['description' => 'The content of the Rule, which uses a Conditional Expression to match user requests. This parameter is not required when you add a global configuration. Supports two Use Cases:'."\n" + ."\n" + .'- To match all incoming requests, set the value to true.'."\n" + ."\n" + .'- To match specific requests, set the value to a custom expression, for example, (http.host eq "video.example.com").', 'type' => 'string', 'required' => false, 'example' => '(http.host eq "video.example.com")', 'title' => ''], ], [ 'name' => 'RequestHeaderModification', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'Modify request headers, supporting add, delete, and modify operations.', + 'description' => 'An array of objects that define Request Header modifications. Supported operations include add, del, and modify.', 'type' => 'array', 'items' => [ - 'description' => 'Details of the request header modification.', + 'description' => 'An object that contains the details of a single Request Header modification.', 'type' => 'object', 'properties' => [ 'Operation' => [ - 'description' => 'Operation type. Possible values:'."\n" + 'description' => 'The operation to perform. Valid values are:'."\n" ."\n" - .'- add: Add.'."\n" - .'- del: Delete'."\n" - .'- modify: Modify.', - 'type' => 'string', - 'required' => true, - 'example' => 'add', - 'enum' => [ - 'add', - 'modify', - 'del', - ], - 'title' => '', - ], - 'Name' => [ - 'description' => 'Request header name.', + .'- add: Adds a header.'."\n" + ."\n" + .'- del: Deletes a header.'."\n" + ."\n" + .'- modify: Modifies a header.', 'type' => 'string', 'required' => true, - 'example' => 'headername'."\n", - 'title' => '', - ], - 'Value' => [ - 'description' => 'Request header value.', - 'type' => 'string', - 'required' => false, - 'example' => 'headervalue'."\n", + 'enum' => ['add', 'modify', 'del'], + 'example' => 'add', 'title' => '', ], + 'Name' => ['description' => 'The Request Header name.', 'type' => 'string', 'required' => true, 'example' => 'headername'."\n", 'title' => ''], + 'Value' => ['description' => 'The Request Header value.', 'type' => 'string', 'required' => false, 'example' => 'headervalue'."\n", 'title' => ''], 'Type' => [ - 'description' => 'Value type. Valid values:'."\n" - .'- static: Static mode.'."\n" - .'- dynamic: Dynamic mode.'."\n", + 'description' => 'The type of the header value. Valid values are:'."\n" + ."\n" + .'- static: Static value.'."\n" + ."\n" + .'- dynamic: Dynamic value.', 'type' => 'string', - 'enum' => [ - 'static', - 'dynamic', - ], + 'enum' => ['static', 'dynamic'], 'required' => false, 'example' => 'static', 'title' => '', @@ -10550,36 +5295,18 @@ [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule execution order. Rules with smaller numeric values are executed first.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The execution order of the Rule. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Response result of the request.', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', - ], - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '35281609698****', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE'], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '35281609698****', 'title' => ''], ], 'example' => '', ], @@ -10587,196 +5314,70 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'VerifyExpressionError', - 'errorMessage' => 'Dynamic expression is invalid.', - 'description' => 'Dynamic expression is invalid.', - ], - [ - 'errorCode' => 'InvalidValOfDelHeader', - 'errorMessage' => 'The delete header operation does not support setting value.', - 'description' => 'The delete header operation does not support setting value.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['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' => '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.'], + ['errorCode' => 'VerifyExpressionError', 'errorMessage' => 'Dynamic expression is invalid.', 'description' => 'Dynamic expression is invalid.'], + ['errorCode' => 'InvalidValOfDelHeader', 'errorMessage' => 'The delete header operation does not support setting value.', 'description' => 'The delete header operation does not support setting value.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], 'title' => 'Create or Modify HTTP Request Header Configuration', 'changeSet' => [ - [ - 'createdAt' => '2025-04-10T07:02:38.000Z', - 'description' => 'Error codes changed, Request parameters changed', - ], - [ - 'createdAt' => '2025-03-27T02:58:49.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-04-10T07:02:38.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2025-03-27T02:58:49.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateHttpRequestHeaderModificationRule', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHttpRequestHeaderModificationRule'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateHttpRequestHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\",\\n \\"ConfigId\\": 0\\n}","type":"json"}]', ], 'CreateHttpResponseHeaderModificationRule' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Creates a rule to modify HTTP response headers.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -10789,126 +5390,84 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257651', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID. You can obtain this by calling the [ListSites](~~2850189~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456******', - 'title' => '', - ], + 'schema' => ['description' => 'The Site ID. You can get this ID by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456******', 'title' => ''], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the version of the site where the configuration will take effect. The default is version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the Site configuration. For sites with Configuration Version Management enabled, this parameter specifies the configuration version that the Rule applies to. If omitted, this parameter defaults to version 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the rule. This parameter is not required when adding a Global Configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Possible values:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', + 'description' => 'Specifies whether to enable the rule. This parameter is not required when adding a Global Configuration. Valid values:'."\n" + ."\n" + .'- `on`: Enables the rule.'."\n" + ."\n" + .'- `off`: Disables the rule.', 'type' => 'string', 'required' => false, + 'enum' => ['on', 'off'], 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- To match all incoming requests: Set the value to true'."\n" - .'- To match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies the conditional expression that an incoming request must match for the rule to apply. This parameter is not required when adding a Global Configuration. You can set the value in one of the following ways:'."\n" + ."\n" + .'- To match all incoming requests, set the value to `true`.'."\n" + ."\n" + .'- To match specific requests, set the value to a custom expression. For example: `(http.host eq "video.example.com")`', 'type' => 'string', 'required' => false, 'example' => '(http.host eq "video.example.com")', 'title' => ''], ], [ 'name' => 'ResponseHeaderModification', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'Modify response headers, supporting add, delete, and modify operations.', + 'description' => 'An array of objects that specify modifications to the response header. The supported operations are `add`, `del`, and `modify`.', 'type' => 'array', 'items' => [ - 'description' => 'Details of the response header modification.', + 'description' => 'An object that defines a single modification to the response header.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'Response header name.', - 'type' => 'string', - 'required' => true, - 'example' => 'headername', - 'title' => '', - ], + 'Name' => ['description' => 'The name of the response header.', 'type' => 'string', 'required' => true, 'example' => 'headername', 'title' => ''], 'Operation' => [ - 'description' => 'Operation type. Possible values:'."\n" + 'description' => 'The modification to perform on the header. Valid values:'."\n" ."\n" - .'- add: Add.'."\n" - .'- del: Delete'."\n" - .'- modify: Modify.', + .'- `add`: Adds a header.'."\n" + ."\n" + .'- `del`: Deletes a header.'."\n" + ."\n" + .'- `modify`: Modifies a header.', 'type' => 'string', 'required' => true, + 'enum' => ['add', 'modify', 'del'], 'example' => 'add', - 'enum' => [ - 'add', - 'modify', - 'del', - ], - 'title' => '', - ], - 'Value' => [ - 'description' => 'Response header value.', - 'type' => 'string', - 'required' => false, - 'example' => 'headervalue', 'title' => '', ], + 'Value' => ['description' => 'The value to assign to the header. This parameter is not required when the `Operation` is `del`.', 'type' => 'string', 'required' => false, 'example' => 'headervalue', 'title' => ''], 'Type' => [ - 'description' => 'Value Type. Valid values:'."\n" - .'- static: Static pattern.'."\n" - .'- dynamic: Dynamic pattern.', + 'description' => 'The value type. Valid values:'."\n" + ."\n" + .'- `static`: Static value.'."\n" + ."\n" + .'- `dynamic`: Dynamic value.', 'type' => 'string', - 'enum' => [ - 'static', - 'dynamic', - ], + 'enum' => ['static', 'dynamic'], 'required' => false, 'example' => 'static', 'title' => '', @@ -10926,36 +5485,18 @@ [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule execution order. Rules with smaller numeric values are executed first.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The rule\'s execution order. A lower value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Request response result.', + 'description' => 'Contains the response data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - ], - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '35281609698****', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'A unique identifier for the request.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74'], + 'ConfigId' => ['description' => 'A unique identifier for the configuration.', 'type' => 'integer', 'format' => 'int64', 'example' => '35281609698****', 'title' => ''], ], 'example' => '', ], @@ -10963,197 +5504,70 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'VerifyExpressionError', - 'errorMessage' => 'Dynamic expression is invalid.', - 'description' => 'Dynamic expression is invalid.', - ], - [ - 'errorCode' => 'InvalidValOfDelHeader', - 'errorMessage' => 'The delete header operation does not support setting value.', - 'description' => 'The delete header operation does not support setting value.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['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' => '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.'], + ['errorCode' => 'VerifyExpressionError', 'errorMessage' => 'Dynamic expression is invalid.', 'description' => 'Dynamic expression is invalid.'], + ['errorCode' => 'InvalidValOfDelHeader', 'errorMessage' => 'The delete header operation does not support setting value.', 'description' => 'The delete header operation does not support setting value.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], 'title' => 'Create or Modify HTTP Response Header Configuration', - 'summary' => 'Add HTTP Response Header Rule', 'changeSet' => [ - [ - 'createdAt' => '2025-04-10T07:02:39.000Z', - 'description' => 'Error codes changed, Request parameters changed', - ], - [ - 'createdAt' => '2025-03-27T02:58:48.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-04-10T07:02:39.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2025-03-27T02:58:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateHttpResponseHeaderModificationRule', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHttpResponseHeaderModificationRule'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateHttpResponseHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"ConfigId\\": 0\\n}","type":"json"}]', ], 'CreateHttpsApplicationConfiguration' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Adds an HTTPS application configuration to a site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -11166,270 +5580,166 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257997', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the Site. You can get this ID by calling the [ListSites](~~ListSites~~) API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Version number of the site configuration. For sites with version management enabled, this parameter can specify the version to which the configuration applies, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The Site\'s configuration Version. For Sites with version management enabled, this parameter specifies the Version to which the configuration applies. The default is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Rule. This parameter is optional when adding a Global Configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Possible values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable the rule. This parameter is optional when adding a Global Configuration. Valid values:'."\n" + ."\n" + .'- `on`: The rule is enabled.'."\n" + ."\n" + .'- `off`: The rule is disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq \\"video.example.com\\")', - 'title' => '', - ], + 'schema' => ['description' => 'The content of the Rule, which is a Conditional Expression that matches user Requests. This parameter is optional when adding a Global Configuration. Supported use cases include:'."\n" + ."\n" + .'- To match all incoming requests, set the value to `true`.'."\n" + ."\n" + .'- To match specific requests, use a custom expression. For example: `(http.host eq "video.example.com")`.', 'type' => 'string', 'required' => false, 'example' => '(http.host eq \\"video.example.com\\")', 'title' => ''], ], [ 'name' => 'HttpsForce', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable forced HTTPS, default is disabled. Possible values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable Force HTTPS. Disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'HttpsForceCode', 'in' => 'query', - 'schema' => [ - 'description' => 'Forced HTTPS redirect status code. Possible values:'."\n" - .'- 301'."\n" - .'- 302'."\n" - .'- 307'."\n" - .'- 308', - 'type' => 'string', - 'required' => false, - 'example' => '301', - 'title' => '', - ], + 'schema' => ['description' => 'The Redirection Status Code to use when Force HTTPS is enabled. Valid values:'."\n" + ."\n" + .'- `301`'."\n" + ."\n" + .'- `302`'."\n" + ."\n" + .'- `307`'."\n" + ."\n" + .'- `308`', 'type' => 'string', 'required' => false, 'example' => '301', 'title' => ''], ], [ 'name' => 'AltSvc', 'in' => 'query', - 'schema' => [ - 'description' => 'Alt-Svc feature switch, default is disabled. Possible values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable the Alt-Svc header. Disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'AltSvcClear', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether the Alt-Svc header includes the clear parameter, default is disabled. Possible values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to include the `clear` parameter in the Alt-Svc header. Disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: The parameter is included.'."\n" + ."\n" + .'- `off`: The parameter is not included.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'AltSvcPersist', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether the Alt-Svc header includes the persist parameter, default is disabled. Possible values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to include the `persist` parameter in the Alt-Svc header. Disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: The parameter is included.'."\n" + ."\n" + .'- `off`: The parameter is not included.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'AltSvcMa', 'in' => 'query', - 'schema' => [ - 'description' => 'Alt-Svc validity period in seconds, default is 86400 seconds.', - 'type' => 'string', - 'required' => false, - 'example' => '86400', - 'title' => '', - ], + 'schema' => ['description' => 'The Max Age for the Alt-Svc header, in seconds. The default is 86400.', 'type' => 'string', 'required' => false, 'example' => '86400', 'title' => ''], ], [ 'name' => 'Hsts', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable HSTS, default is disabled. Possible values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable HTTP Strict Transport Security (HSTS). Disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'HstsMaxAge', 'in' => 'query', - 'schema' => [ - 'description' => 'HSTS expiration time in seconds.', - 'type' => 'string', - 'required' => false, - 'example' => '3600', - 'title' => '', - ], + 'schema' => ['description' => 'The value of the `max-age` directive for the HSTS header, in seconds.', 'type' => 'string', 'required' => false, 'example' => '3600', 'title' => ''], ], [ 'name' => 'HstsIncludeSubdomains', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to include subdomains in HSTS, default is disabled. Possible values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to include the `includeSubDomains` directive in the HSTS header. Disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: The directive is included.'."\n" + ."\n" + .'- `off`: The directive is not included.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'HstsPreload', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable HSTS preload, default is disabled. Possible values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable HSTS Preload by including the `preload` directive in the HSTS header. Disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: The directive is included.'."\n" + ."\n" + .'- `off`: The directive is not included.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule execution order. A smaller numeric value indicates higher priority.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The execution order of the rule. A lower value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'HttpsSniVerify', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable SNI validation. Disabled by default. Valid values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable Server Name Indication (SNI) verification. Disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'HttpsNoSniDeny', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to deny TLS handshake requests without Server Name Indication (SNI). By default, this feature is disabled. Valid values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to reject TLS Handshake Requests that do not include an SNI. Disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: Rejects requests without an SNI.'."\n" + ."\n" + .'- `off`: Allows requests without an SNI.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'HttpsSniWhitelist', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies the allowed SNI whitelist. Multiple entries are separated by spaces.', - 'type' => 'string', - 'required' => false, - 'example' => 'abc edf', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies the allowlist of SNI values. Separate multiple values with a space.', 'type' => 'string', 'required' => false, 'example' => 'abc edf', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - ], - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '352816096987136', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'], + 'ConfigId' => ['description' => 'The ID of the configuration.', 'type' => 'integer', 'format' => 'int64', 'example' => '352816096987136', 'title' => ''], ], 'example' => '', ], @@ -11437,172 +5747,65 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], 'title' => 'Add Site HTTPS Application Configuration', - 'summary' => 'Create a new site HTTPS application configuration', 'changeSet' => [ - [ - 'createdAt' => '2025-06-03T07:09:13.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2025-03-27T02:58:48.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-06-03T07:09:13.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-27T02:58:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateHttpsApplicationConfiguration', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHttpsApplicationConfiguration'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateHttpsApplicationConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"ConfigId\\": 352816096987136\\n}","type":"json"}]', ], 'CreateHttpsBasicConfiguration' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Create HTTPS basic configuration for a site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -11615,222 +5818,117 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257999', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '5407498413****', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5407498413****', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - 'title' => '', - ], + 'schema' => ['description' => 'Rule name. This parameter does not need to be set when adding a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Rule switch. This parameter does not need to be set when adding a global configuration. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq \\"video.example.com\\")'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'Rule content, using conditional expressions to match user requests. This parameter does not need to be set when adding a global configuration. There are two usage scenarios:'."\n" + .'- Match all incoming requests: set the value to true'."\n" + .'- Match specified requests: set the value to a custom expression, for example: (http.host eq "video.example.com")', 'type' => 'string', 'required' => false, 'example' => '(http.host eq \\"video.example.com\\")'."\n", 'title' => ''], ], [ 'name' => 'Https', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable HTTPS. Default is enabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Whether to enable HTTPS. Enabled by default. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Tls10', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable TLS1.0. Default is disabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Whether to enable TLS 1.0. Disabled by default. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Tls11', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable TLS1.1. Default is enabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Whether to enable TLS 1.1. Enabled by default. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Tls12', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable TLS1.2. Default is enabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Whether to enable TLS 1.2. Enabled by default. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Tls13', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable TLS1.3. Default is enabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Whether to enable TLS 1.3. Enabled by default. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'CiphersuiteGroup', 'in' => 'query', - 'schema' => [ - 'description' => 'Cipher suite group. Default uses all cipher suites. Value range:'."\n" - .'- all: All cipher suites.'."\n" - .'- strict: Strong cipher suites.'."\n" - .'- custom: Custom cipher suites.', - 'type' => 'string', - 'required' => false, - 'example' => 'all', - 'title' => '', - ], + 'schema' => ['description' => 'Cipher suite group. All cipher suites are used by default. Valid values:'."\n" + .'- all: all cipher suites.'."\n" + .'- strict: strong cipher suites.'."\n" + .'- custom: custom cipher suites.', 'type' => 'string', 'required' => false, 'example' => 'all', 'title' => ''], ], [ 'name' => 'Ciphersuite', 'in' => 'query', - 'schema' => [ - 'description' => 'Custom cipher suite, indicating the specific encryption algorithm selected when CiphersuiteGroup is set to custom.', - 'type' => 'string', - 'required' => false, - 'example' => 'TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256', - 'title' => '', - ], + 'schema' => ['description' => 'Custom cipher suite, specifying the specific encryption algorithms selected when CiphersuiteGroup is set to custom.', 'type' => 'string', 'required' => false, 'example' => 'TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256', 'title' => ''], ], [ 'name' => 'OcspStapling', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable OCSP. Default is disabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Whether to enable OCSP stapling. Disabled by default. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Http2', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable HTTP2. Default is enabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Whether to enable HTTP/2. Enabled by default. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Http3', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable HTTP3. Default is enabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Whether to enable HTTP/3. Enabled by default. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule execution order. A smaller numeric value indicates higher priority. ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'Rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - ], - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '352816096987136', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '352816096987136', 'title' => ''], ], 'example' => '', ], @@ -11838,168 +5936,65 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'Add Site HTTPS Basic Configuration', - 'summary' => 'Create a new site HTTPS basic configuration', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"ConfigId\\": 352816096987136\\n}","type":"json"}]', + 'title' => 'Create HTTPS basic configuration for a site', + 'description' => 'A site supports only one global configuration (without Rule-related parameters). To exceed this limit, you must provide the RuleName, Rule, and RuleEnable parameters to create a rule-based configuration.', 'changeSet' => [ - [ - 'createdAt' => '2025-03-27T02:58:48.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-03-27T02:58:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateHttpsBasicConfiguration', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHttpsBasicConfiguration'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateHttpsBasicConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"ConfigId\\": 352816096987136\\n}","type":"json"}]', ], 'CreateImageTransform' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Creates an image transformation configuration for a site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -12012,48 +6007,29 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257352', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the effective version of the site configuration, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version on which the configuration takes effect. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'Enable', 'in' => 'query', 'schema' => [ - 'description' => 'Indicates whether image transformation is enabled. Possible values:'."\n" + 'description' => 'Specifies whether to enable image transformation. Valid values:'."\n" .'- on: Enabled.'."\n" .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], 'example' => 'on', 'title' => '', ], @@ -12061,27 +6037,18 @@ [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. This parameter is not required when you add a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Possible values:'."\n" + 'description' => 'Specifies whether to enable the rule. This parameter is not required when you add a global configuration. Valid values:'."\n" .'- on: Enabled.'."\n" .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], 'example' => 'on', 'title' => '', ], @@ -12089,49 +6056,39 @@ [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- To match all incoming requests: Set the value to true'."\n" - .'- To match specific requests: Set the value to a custom expression, for example: (http.host eq "video.example.com")', - 'type' => 'string', - 'required' => false, - 'example' => '(http.request.uri.path.file_name eq \\"jpg\\")', - 'title' => '', - ], + 'schema' => ['description' => 'The rule content, which uses a conditional expression to match user requests. This parameter is not required when you add a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + .'- Match specified requests: Set the value to a custom expression, such as (http.host eq \\"video.example.com\\").', 'type' => 'string', 'required' => false, 'example' => '(http.request.uri.path.file_name eq \\"jpg\\")', 'title' => ''], ], [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule execution order. Rules with smaller numeric values are executed first.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The execution order of the rule. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'AutoWebp', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to enable adaptive WebP. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'required' => false], + ], + [ + 'name' => 'AutoAvif', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to enable adaptive AVIF. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - ], - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '352816096987136', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9'], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '352816096987136', 'title' => ''], ], 'example' => '', ], @@ -12139,169 +6096,63 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'Add Site Image Transformation Configuration', - 'summary' => 'Add Site Image Transformation Configuration', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"ConfigId\\": 352816096987136\\n}","type":"json"}]', + 'title' => 'Create site image transformation configuration', 'changeSet' => [ - [ - 'createdAt' => '2025-03-27T02:58:48.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-03-27T02:58:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateImageTransform', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateImageTransform'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateImageTransform', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"ConfigId\\": 352816096987136\\n}","type":"json"}]', ], 'CreateKvNamespace' => [ - 'summary' => 'Create a namespace in your Alibaba Cloud account.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -12314,33 +6165,19 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238788', - 'abilityTreeNodes' => [ - 'FEATUREdcdnGMYWU5', - ], + 'abilityTreeNodes' => ['FEATUREdcdnGMYWU5'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Namespace', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_namespace', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the KV namespace.', 'type' => 'string', 'required' => true, 'example' => 'test_namespace', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'this is a test namespace.', - 'title' => '', - ], + 'schema' => ['description' => 'An optional description for the KV namespace.', 'type' => 'string', 'required' => false, 'example' => 'this is a test namespace.', 'title' => ''], ], ], 'responses' => [ @@ -12348,43 +6185,19 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the namespace. Valid values:'."\n" - ."\n" - .'* **online**: working as expected.'."\n" - .'* **delete**: pending deletion.'."\n" - .'* **deleting**: being deleted.'."\n" - .'* **deleted**: deleted.'."\n", - 'type' => 'string', - 'example' => 'online', - 'title' => '', - ], - 'Namespace' => [ - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'example' => 'test_namespace', - 'maxLength' => 64, - 'pattern' => '^[0-9a-zA-Z_-]+$', - 'title' => '', - ], - 'NamespaceId' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'example' => '657717877171818496', - 'title' => '', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', - 'title' => '', - ], - 'Description' => [ - 'description' => 'The description of the namespace.'."\n", - 'type' => 'string', - 'example' => 'this is a test namespace.', - 'title' => '', - ], + 'Status' => ['description' => 'The status of the KV namespace. Valid values:'."\n" + ."\n" + .'- **online**: The namespace is available.'."\n" + ."\n" + .'- **delete**: The namespace is pending deletion.'."\n" + ."\n" + .'- **deleting**: The namespace is being deleted.'."\n" + ."\n" + .'- **deleted**: The namespace is deleted.', 'type' => 'string', 'example' => 'online', 'title' => ''], + 'Namespace' => ['description' => 'The name of the KV namespace.', 'type' => 'string', 'maxLength' => 64, 'pattern' => '^[0-9a-zA-Z_-]+$', 'example' => 'test_namespace', 'title' => ''], + 'NamespaceId' => ['description' => 'The ID of the KV namespace.', 'type' => 'string', 'example' => '657717877171818496', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', 'title' => ''], + 'Description' => ['description' => 'The description of the KV namespace.', 'type' => 'string', 'example' => 'this is a test namespace.', 'title' => ''], ], 'description' => '', 'title' => '', @@ -12394,133 +6207,48 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidAccount.Malformed', - 'errorMessage' => 'The specified account is invalid.', - 'description' => 'The account number is not entered correctly, for example, the input is empty.', - ], - [ - 'errorCode' => 'InvalidNameSpace.Malformed', - 'errorMessage' => 'The specified namespace is invalid.', - 'description' => 'The bucket name is entered incorrectly, such as an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.Malformed', - 'errorMessage' => 'The specified key is invalid.', - 'description' => 'Key name input error, such as entering an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.ExceedsMaximum', - 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', - 'description' => 'The length of the requested key is too large.', - ], - [ - 'errorCode' => 'InvalidValue.ExceedsMaximum', - 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', - 'description' => 'The value deposited is too large.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests.Please try again later.', - 'description' => 'Requests are too frequent, please try again later.', - ], + ['errorCode' => 'InvalidAccount.Malformed', 'errorMessage' => 'The specified account is invalid.', 'description' => 'The account number is not entered correctly, for example, the input is empty.'], + ['errorCode' => 'InvalidNameSpace.Malformed', 'errorMessage' => 'The specified namespace is invalid.', 'description' => 'The bucket name is entered incorrectly, such as an empty string.'], + ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified key is invalid.', 'description' => 'Key name input error, such as entering an empty string.'], + ['errorCode' => 'InvalidKey.ExceedsMaximum', 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', 'description' => 'The length of the requested key is too large.'], + ['errorCode' => 'InvalidValue.ExceedsMaximum', 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', 'description' => 'The value deposited is too large.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidParameters', - 'errorMessage' => 'The specified authentication parameters are invalid.', - 'description' => 'Authentication parameter input error.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], - [ - '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' => 'The maximum storage capacity of the Edge KV namespace has been reached. Delete unwanted key-value pairs to save the storage.', - ], + ['errorCode' => 'Unauthorized.InvalidParameters', 'errorMessage' => 'The specified authentication parameters are invalid.', 'description' => 'Authentication parameter input error.'], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], + ['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' => 'The maximum storage capacity of the Edge KV namespace has been reached. Delete unwanted key-value pairs to save the storage.'], ], [ - [ - 'errorCode' => 'InvalidAccount.NotFound', - 'errorMessage' => 'The specified account does not exist.', - 'description' => 'The specified account does not exist.', - ], - [ - 'errorCode' => 'InvalidNameSpace.NotFound', - 'errorMessage' => 'The specified namespace does not exist.', - 'description' => '', - ], - [ - 'errorCode' => 'InvalidKey.NotFound', - 'errorMessage' => 'The specified key does not exist.', - 'description' => 'The specified key-value pair does not exist.', - ], + ['errorCode' => 'InvalidAccount.NotFound', 'errorMessage' => 'The specified account does not exist.', 'description' => 'The specified account does not exist.'], + ['errorCode' => 'InvalidNameSpace.NotFound', 'errorMessage' => 'The specified namespace does not exist.', 'description' => ''], + ['errorCode' => 'InvalidKey.NotFound', 'errorMessage' => 'The specified key does not exist.', 'description' => 'The specified key-value pair does not exist.'], ], 406 => [ - [ - 'errorCode' => 'InvalidNameSpace.Duplicate', - 'errorMessage' => 'The specified namespace already exists.', - 'description' => 'Specified storage space', - ], - [ - 'errorCode' => 'InvalidNameSpace.QuotaFull', - 'errorMessage' => 'The maximum number of namespaces is exceeded.', - 'description' => 'The number of storage spaces exceeds the capacity limit.', - ], - [ - 'errorCode' => 'InvalidKey.QuotaFull', - 'errorMessage' => 'The total number of IP exceeds the quota.', - 'description' => 'The total number of ip addresses exceeds the quota.', - ], + ['errorCode' => 'InvalidNameSpace.Duplicate', 'errorMessage' => 'The specified namespace already exists.', 'description' => 'Specified storage space'], + ['errorCode' => 'InvalidNameSpace.QuotaFull', 'errorMessage' => 'The maximum number of namespaces is exceeded.', 'description' => 'The number of storage spaces exceeds the capacity limit.'], + ['errorCode' => 'InvalidKey.QuotaFull', 'errorMessage' => 'The total number of IP exceeds the quota.', 'description' => 'The total number of ip addresses exceeds the quota.'], ], 429 => [ - [ - 'errorCode' => 'TooQuickRequests', - 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', - 'description' => 'The modification or deletion of key-value pairs is too frequent.', - ], + ['errorCode' => 'TooQuickRequests', 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', 'description' => 'The modification or deletion of key-value pairs is too frequent.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'CreateKvNamespace', + 'summary' => 'Creates a KV namespace in the current account.', 'changeSet' => [ - [ - 'createdAt' => '2025-04-03T01:43:48.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-04-03T01:43:48.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '5', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateKvNamespace', - ], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateKvNamespace'], ], ], 'ramActions' => [ @@ -12531,12 +6259,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -12544,14 +6267,9 @@ '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' => 'Creates a list. Lists are used for the referencing of values in the rules engine to implement complex logic and control in security policies.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Creates a custom list. Custom lists are typically referenced by the rule matching engine for values used in various security policies to implement complex logic and control.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -12564,44 +6282,26 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239651', - 'abilityTreeNodes' => [ - 'FEATUREdcdnL8HX1L', - ], + 'abilityTreeNodes' => ['FEATUREdcdnL8HX1L'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the list that you want to create.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'example', - ], + 'schema' => ['title' => '', 'description' => 'The name of the custom list.'."\n" + ."\n" + .'**Naming rules**: Only letters, digits, and underscores are supported (`^\\w{1,64}$`). The name must be 1 to 64 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'example'], ], [ 'name' => 'Kind', 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => 'The type of the list that you want to create.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ip', - ], + 'schema' => ['title' => '', 'description' => 'The kind of the custom list. This parameter specifies the type of the custom list.', 'type' => 'string', 'example' => 'ip', 'required' => false], ], [ 'name' => 'Description', 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => 'The description of the list that you want to create.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a custom list', - ], + 'schema' => ['title' => '', 'description' => 'The description of the custom list. This parameter provides detailed information about the custom list.', 'type' => 'string', 'example' => 'a custom list', 'required' => false], ], [ 'name' => 'Items', @@ -12609,15 +6309,9 @@ 'style' => 'json', 'schema' => [ 'title' => '', - 'description' => 'The items in the list that you want to create.'."\n", + 'description' => 'The list items. This parameter provides the specific item data for the list.', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'The item in the list that you want to create.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10.1.1.1', - ], + 'items' => ['title' => '', 'description' => 'The list items. This parameter provides the specific item data for the list.', 'type' => 'string', 'example' => '10.1.1.1', 'required' => false], 'required' => false, 'example' => 'a custom list', ], @@ -12626,23 +6320,12 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], - 'Id' => [ - 'title' => '', - 'description' => 'The ID of the custom list.[](~~2850217~~)'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '40000001', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], + 'Id' => ['title' => '', 'description' => 'The ID of the custom list. You can obtain this value by calling the [ListLists](~~2850217~~) operation.', 'type' => 'integer', 'format' => 'int64', 'example' => '40000001'], ], 'example' => '', ], @@ -12650,63 +6333,26 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], 403 => [ - [ - 'errorCode' => '%s.NotSupport', - 'errorMessage' => 'The specified resource type %s is not supported.', - 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.', - ], - [ - 'errorCode' => '%s.OverQuota', - 'errorMessage' => 'The quantity of %s exceeds the quota.', - 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.', - ], - [ - 'errorCode' => '%s.WrongValueMatched', - 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', - 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.', - ], - [ - 'errorCode' => 'List.Name.AlreadyExist', - 'errorMessage' => 'The specified list name already exists.', - 'description' => 'The specified list name is already used by another list.', - ], + ['errorCode' => '%s.NotSupport', 'errorMessage' => 'The specified resource type %s is not supported.', 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.'], + ['errorCode' => '%s.OverQuota', 'errorMessage' => 'The quantity of %s exceeds the quota.', 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.'], + ['errorCode' => '%s.WrongValueMatched', 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.'], + ['errorCode' => 'List.Name.AlreadyExist', 'errorMessage' => 'The specified list name already exists.', 'description' => 'The specified list name is already used by another list.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Id\\": 40000001\\n}","type":"json"}]', - 'title' => 'CreateList', + 'title' => 'Create a custom list', 'changeSet' => [ - [ - 'createdAt' => '2024-09-25T07:02:49.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T09:53:47.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-25T07:02:49.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T09:53:47.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateList', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateList'], ], ], 'ramActions' => [ @@ -12717,24 +6363,16 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CreateLoadBalancer' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Creates a load balancer instance that supports custom routing policies, session persistence, monitoring configurations, and other advanced features.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -12747,36 +6385,25 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238480', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the load balancer, which must meet the domain name format validation and be a subdomain under the site.', - 'type' => 'string', - 'required' => true, - 'example' => 'lb.example.com', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the load balancer. The name must be in a valid domain name format and must be a subdomain of the site.', 'type' => 'string', 'required' => true, 'example' => 'lb.example.com', 'title' => ''], ], [ 'name' => 'Enabled', 'in' => 'query', 'schema' => [ - 'description' => 'Whether the load balancer is enabled.'."\n" + 'description' => 'Specifies whether the load balancer is enabled. Valid values:'."\n" ."\n" .'- true: Enabled.'."\n" .'- false: Not enabled.', + 'enumValueTitles' => ['true' => 'Enabled.', 'false' => 'Not enabled.'], 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], 'example' => 'true', 'title' => '', ], @@ -12784,33 +6411,21 @@ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], ], [ 'name' => 'AdaptiveRouting', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'Configuration for failover across pools.', + 'description' => 'The cross-origin address pool back-to-origin configuration.', 'type' => 'object', 'properties' => [ - 'FailoverAcrossPools' => [ - 'description' => 'Whether to failover across pools.'."\n" - ."\n" - .'- true: Yes.'."\n" - .'- false: No.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], + 'FailoverAcrossPools' => ['description' => 'Specifies whether to enable cross-origin address pool failover. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Not enabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'OriginLevelRetry' => ['description' => 'Specifies whether to retry the next IP address when back-to-origin fails and the origin server is a domain name that resolves to multiple IP addresses.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], 'required' => false, 'example' => 'true', @@ -12822,16 +6437,9 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'List of default pools.', + 'description' => 'The list of default address pool IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'ID of the default pool, an integer.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '95223818027****', - 'title' => '', - ], + 'items' => ['description' => 'The default address pool ID. The value is an integer.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '95223818027****', 'title' => ''], 'required' => true, 'example' => '123', 'title' => '', @@ -12840,42 +6448,22 @@ [ 'name' => 'FallbackPool', 'in' => 'query', - 'schema' => [ - 'description' => 'Fallback pool ID, where traffic will be directed when all other pools are unavailable.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - 'title' => '', - ], + 'schema' => ['description' => 'The fallback address pool ID. Traffic is directed to this pool when all other pools are unavailable.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', 'title' => ''], ], [ 'name' => 'RandomSteering', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'Weighted round-robin configuration, used to control the traffic distribution weights among different pools.', + 'description' => 'The weighted round-robin configuration that controls the traffic distribution weight across different address pools.', 'type' => 'object', 'properties' => [ - 'DefaultWeight' => [ - 'description' => 'Default weight for all pools that do not have individual weights specified. The value range is an integer between 0 and 100.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - 'title' => '', - ], + 'DefaultWeight' => ['description' => 'The default round-robin weight applied to all address pools that do not have an individually specified weight. Valid values: integers from 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], 'PoolWeights' => [ - 'description' => 'Weight configuration for each backend server pool, with the key being the pool ID and the value being the weight coefficient. The weight coefficient represents the proportion of relative traffic distribution.', + 'description' => 'The weight configuration for each backend server pool. The key is the pool ID and the value is the weight coefficient. The weight coefficient represents the relative proportion of traffic distribution.', 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => 'Weight for a single origin pool, a number between 0 and 100, where 0 means no traffic will be directed to this pool.', - 'example' => '50', - 'title' => '', - ], + 'additionalProperties' => ['description' => 'The weight of a single origin address pool. Valid values: 0 to 100. A value of 0 indicates that no traffic is routed to this origin address pool.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], 'title' => '', 'example' => '', ], @@ -12890,141 +6478,79 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'Rule information.', + 'description' => 'The rule information.', 'type' => 'array', 'items' => [ - 'description' => 'Rule structure.', + 'description' => 'The rule struct.', 'type' => 'object', 'properties' => [ - 'RuleName' => [ - 'description' => 'The name of the rule. This parameter does not need to be set when adding global configurations.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_1', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter does not need to be set when adding global configurations. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, e.g., (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")', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Rule switch. This parameter does not need to be set when adding global configurations. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'RuleName' => ['description' => 'The rule name. This parameter is not required when you add a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_1', 'title' => ''], + 'Rule' => ['description' => 'The rule content that uses conditional expressions to match user requests. This parameter is not required when you add a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + .'- Match specified requests: Set the value to a custom expression, such as (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")', 'title' => ''], + 'RuleEnable' => ['description' => 'The rule switch. This parameter is not required when you add a global configuration. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], 'FixedResponse' => [ - 'description' => 'Execute a specified response after matching the rule.', + 'description' => 'The fixed response content returned after a rule is matched.', 'type' => 'object', 'properties' => [ - 'ContentType' => [ - 'description' => 'Content-Type field in the HTTP Header.', - 'type' => 'string', - 'required' => false, - 'example' => 'application/octet-stream', - 'title' => '', - ], - 'Location' => [ - 'description' => 'Location field in the HTTP response.', - 'type' => 'string', - 'required' => false, - 'example' => 'http://www.example.com/index.html', - 'title' => '', - ], - 'MessageBody' => [ - 'description' => 'Response body value.', - 'type' => 'string', - 'required' => false, - 'example' => 'Hello World!', - 'title' => '', - ], - 'StatusCode' => [ - 'description' => 'Response status code.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '200', - 'title' => '', - ], + 'ContentType' => ['description' => 'The Content-Type field in the HTTP header.', 'type' => 'string', 'required' => false, 'example' => 'application/octet-stream', 'title' => ''], + 'Location' => ['description' => 'The location field in the HTTP response.', 'type' => 'string', 'required' => false, 'example' => 'http://www.example.com/index.html', 'title' => ''], + 'MessageBody' => ['description' => 'The response body value.', 'type' => 'string', 'required' => false, 'example' => 'Hello World!', 'title' => ''], + 'StatusCode' => ['description' => 'The response status code.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200', 'title' => ''], ], 'required' => false, 'example' => '{"content_type": "application/json", "location": "www.example.com", "message_body": "Testing Hello", "status_code": 0}', 'title' => '', ], - 'Overrides' => [ - 'description' => 'Modify the corresponding load balancing configuration after matching the rule. The fields in the configuration will override the corresponding fields in the load balancer configuration.', - '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" - .' }', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'The execution order of the rule. It can be left blank, in which case the rules will be executed in the order they appear in the list. If specified, it must be a positive integer, with higher values indicating higher priority.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], - 'Terminates' => [ - 'description' => 'Whether to terminate the execution of subsequent rules.'."\n" - ."\n" - .'- true: Yes.'."\n" - .'- false: No, default value.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], + 'Overrides' => ['description' => 'The load balancing configuration that overwrites the corresponding fields in the load balancer configuration when a rule is matched. The specified fields overwrite the corresponding fields in the load balancer configuration.', '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" + .' }', 'title' => ''], + 'Sequence' => ['description' => 'The rule execution order. This parameter is optional. If not specified, rules are executed in list order. If specified, the value must be a positive integer. A larger value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'Terminates' => ['description' => 'Specifies whether to stop executing subsequent rules. Valid values:'."\n" + ."\n" + .'- true: Stop executing subsequent rules.'."\n" + .'- false: Continue executing subsequent rules. This is the default value.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], 'required' => false, 'title' => '', @@ -13048,172 +6574,79 @@ 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ - 'description' => 'Session persistence, with possible values:'."\n" - .'- off: Not enabled.'."\n" - .'- ip: Session persistence by IP.'."\n" - .'- cookie: Session persistence by cookie.', + 'description' => 'The session persistence mode. Valid values:'."\n" + .'- off: disabled.'."\n" + .'- ip: IP-based session persistence.'."\n" + .'- cookie: cookie-based session persistence.'."\n" + .'- http_header: HTTP header-based session persistence.', 'type' => 'string', + 'enum' => [], 'required' => false, 'example' => 'ip', - 'enum' => [], 'title' => '', ], ], [ 'name' => 'SteeringPolicy', 'in' => 'query', - 'schema' => [ - 'description' => 'Load balancing strategy.'."\n" - ."\n" - .'- geo: Geographical strategy.'."\n" - .'- random: Weighted round-robin.'."\n" - .'- order: Primary and backup method.', - 'type' => 'string', - 'required' => true, - 'example' => 'order', - 'title' => '', - ], + 'schema' => ['description' => 'The load balancing policy. Valid values:'."\n" + ."\n" + .'- geo: geo-based routing.'."\n" + .'- random: weighted round-robin.'."\n" + .'- order: primary/secondary mode.', 'type' => 'string', 'required' => true, 'example' => 'order', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'Detailed description of the load balancer, for easier management and identification.', - 'type' => 'string', - 'required' => false, - 'example' => '测试负载均衡器描述', - 'title' => '', - ], + 'schema' => ['description' => 'The description of the load balancer for management and identification purposes.', 'type' => 'string', 'required' => false, 'example' => 'Load Balancer Description', 'title' => ''], ], [ 'name' => 'Ttl', 'in' => 'query', - 'schema' => [ - 'description' => 'TTL value, the time-to-live for DNS records, with a default of 30 seconds. The value range is 10-600.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '300', - 'title' => '', - ], + 'schema' => ['description' => 'The TTL value, which specifies the time-to-live of the DNS record. Default value: 30 seconds. Valid values: 10 to 600.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '300', 'title' => ''], ], [ 'name' => 'Monitor', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'Monitor configuration, used for health checks.', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'Monitor protocol type, such as HTTP, used for health checks. When set to `off`, no check is performed.'."\n" - ."\n" - .'- TCP'."\n" - .'- UDP'."\n" - .'- SMTP'."\n" - .'- HTTPS'."\n" - .'- HTTP'."\n" - .'- ICMP Ping'."\n" - .'- off', - 'type' => 'string', - 'required' => false, - 'example' => 'HTTP', - 'title' => '', - ], - 'Method' => [ - 'description' => 'Monitor request method, such as `GET`, which is a method in the HTTP protocol.', - 'type' => 'string', - 'required' => false, - 'example' => 'GET', - 'title' => '', - ], - 'Port' => [ - 'description' => 'Origin server port.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1921', - 'title' => '', - ], - 'Path' => [ - 'description' => 'Monitor check path, such as `/healthcheck`, which is an HTTP request path.', - 'type' => 'string', - 'required' => false, - 'example' => '/health', - 'title' => '', - ], - 'Interval' => [ - 'description' => 'Monitoring interval, such as `60` seconds, which is the frequency of checks.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - 'title' => '', - ], - 'Timeout' => [ - 'description' => 'Application health check timeout, in seconds, with a value range of 1-10.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - 'title' => '', - ], - 'ExpectedCodes' => [ - 'description' => 'Expected status codes, such as `200,202`, which are successful HTTP responses.', - 'type' => 'string', - 'required' => false, - 'example' => '200', - 'title' => '', - ], - 'FollowRedirects' => [ - 'description' => 'Whether to follow redirects.'."\n" - ."\n" - .'- true: Yes.'."\n" - .'- false: No.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], - 'ConsecutiveUp' => [ - 'description' => 'Number of consecutive successful probes required to consider the target healthy, such as `3`.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - 'title' => '', - ], - 'ConsecutiveDown' => [ - 'description' => 'Number of consecutive failed probes required to consider the target unhealthy, such as `5`.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - 'title' => '', - ], - 'Header' => [ - 'description' => 'Header information included in the probe, which is an HTTP header.', - 'type' => 'any', - 'required' => false, - 'example' => ' {'."\n" - .' "host": ['."\n" - .' "example1.com",'."\n" - .' "example2.com"'."\n" - .' ]'."\n" - .' }', - 'title' => '', - ], + 'description' => 'The monitor configuration for health checks.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The monitor protocol type used for health checks. A value of off indicates that health checks are disabled. Valid values:'."\n" + ."\n" + .'- TCP'."\n" + .'- UDP'."\n" + .'- SMTP'."\n" + .'- HTTPS'."\n" + .'- HTTP'."\n" + .'- ICMP Ping'."\n" + .'- off', 'type' => 'string', 'required' => false, 'example' => 'HTTP', 'title' => ''], + 'Method' => ['description' => 'The monitor request method, such as `GET`. This is the HTTP method used for health checks.', 'type' => 'string', 'required' => false, 'example' => 'GET', 'title' => ''], + 'Port' => ['description' => 'The origin server port.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1921', 'title' => ''], + 'Path' => ['description' => 'The monitor check path, such as `/healthcheck`. This is the URI of the request.', 'type' => 'string', 'required' => false, 'example' => '/health', 'title' => ''], + 'Interval' => ['description' => 'The monitoring interval in seconds, such as `60`. This specifies the check frequency.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''], + 'Timeout' => ['description' => 'The health check timeout period. Unit: seconds. Valid values: 1 to 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], + 'ExpectedCodes' => ['description' => 'The expected status codes, such as `200,202`. These are the HTTP response codes that indicate success.', 'type' => 'string', 'required' => false, 'example' => '200', 'title' => ''], + 'FollowRedirects' => ['description' => 'Specifies whether to follow redirects. Valid values:'."\n" + ."\n" + .'- true: Follow redirects.'."\n" + .'- false: Do not follow redirects.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'ConsecutiveUp' => ['description' => 'The number of consecutive successful probes required to consider the check successful, such as `3`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'ConsecutiveDown' => ['description' => 'The number of consecutive failed probes required to consider the check failed, such as `5`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], + 'Header' => ['description' => 'The header information included in the probe request. This is the HTTP header.', 'type' => 'any', 'required' => false, 'example' => ' {'."\n" + .' "host": ['."\n" + .' "example1.com",'."\n" + .' "example2.com"'."\n" + .' ]'."\n" + .' }', 'title' => ''], 'MonitoringRegion' => [ - 'enumValueTitles' => [ - 'OutsideChineseMainland' => 'OutsideChineseMainland', - 'ChineseMainland' => 'ChineseMainland', - 'Global' => 'Global', - ], - 'description' => 'The area where the detection point is located. The default value is Global.'."\n" + 'description' => 'The region where the probe nodes are located. Default value: Global. Valid values:'."\n" ."\n" - .'- Global: Global.'."\n" + .'- Global: worldwide.'."\n" .'- ChineseMainland: the Chinese mainland.'."\n" - .'- OutsideChineseMainland: Global (excluding the Chinese mainland).', + .'- OutsideChineseMainland: worldwide (excluding the Chinese mainland).', + 'enumValueTitles' => ['OutsideChineseMainland' => 'Worldwide (excluding the Chinese mainland)', 'ChineseMainland' => 'The Chinese mainland.', 'Global' => 'Worldwide.'], 'type' => 'string', 'required' => false, 'example' => 'Global', @@ -13228,54 +6661,31 @@ [ 'name' => 'SubRegionPools', 'in' => 'query', - 'schema' => [ - 'description' => 'Address pools corresponding to secondary regions. When multiple secondary regions share the same set of address pools, the keys can be concatenated with commas.', - 'type' => 'any', - 'required' => false, - 'example' => '{"AL,MO": [92298024898****],"CN-SH,CN-SX,CN-SC":[92304347804****,92843536908****]}', - 'title' => '', - ], + 'schema' => ['description' => 'The address pools mapped to secondary regions. If multiple secondary regions share the same set of address pools, you can concatenate the secondary region names with commas as the key.', 'type' => 'any', 'required' => false, 'example' => '{"AL,MO": [92298024898****],"CN-SH,CN-SX,CN-SC":[92304347804****,92843536908****]}', 'title' => ''], ], [ 'name' => 'RegionPools', 'in' => 'query', - 'schema' => [ - 'description' => 'Address pools corresponding to primary regions.', - 'type' => 'any', - 'required' => false, - 'example' => '{'."\n" - .' "ENAM": ['."\n" - .' 12345678****'."\n" - .' ],'."\n" - .' "WNAM": ['."\n" - .' 23456789****,'."\n" - .' 23456789****'."\n" - .' ]'."\n" - .'}', - 'title' => '', - ], + 'schema' => ['description' => 'The address pools mapped to primary regions.', 'type' => 'any', 'required' => false, 'example' => '{'."\n" + .' "ENAM": ['."\n" + .' 12345678****'."\n" + .' ],'."\n" + .' "WNAM": ['."\n" + .' 23456789****,'."\n" + .' 23456789****'."\n" + .' ]'."\n" + .'}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n", - ], - 'Id' => [ - 'description' => 'Load balancer ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '99867648760****', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n"], + 'Id' => ['description' => 'The load balancer ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '99867648760****', 'title' => ''], ], 'example' => '', ], @@ -13283,175 +6693,72 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'LoadBalancerQuotaCheckFailed', - 'errorMessage' => 'Load balancer enable quota check failed.', - 'description' => 'Your current plan cannot use the load balancer related functions. If you need to use it, upgrade the plan.', - ], - [ - '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' => '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.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'LoadBalancerPolicyCheckFailed', - 'errorMessage' => 'Your current plan does not support the load balancer scheduling policy. Upgrade the plan and try again.', - 'description' => 'Your current plan does not support the load balancer scheduling policy. Upgrade the plan and try again.', - ], - [ - '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' => 'Your current plan does not allow you to configure the load balancer\'s health detection. Upgrade the plan and try again.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'MonitorExpectedBodyInvalid', - 'errorMessage' => 'Invalid response body. Specify a response body that does not exceed 102,400 characters in length in your custom rule.', - 'description' => 'Invalid response body. Specify a response body that does not exceed 102,400 characters in length in your custom rule.', - ], - [ - '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' => '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.', - ], - [ - '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' => 'The incoming monitor is carrying an illegal request header. Make sure that the number of request headers does not exceed 10, that each request header has a value length between 1 and 10, and that you must not use the User-Agent request header (which is reserved for internal specific scenarios). In addition, the total length of all request headers and their values must not exceed 6000 characters. Please check and correct the request header configuration and try again.', - ], - [ - 'errorCode' => 'MonitorMethodNotSupport', - 'errorMessage' => 'Invalid HTTP method for the probe request. Valid values are GET and HEAD.', - 'description' => 'Invalid HTTP method for the probe request. Valid values are GET and 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' => '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.', - ], - [ - 'errorCode' => 'MonitorPortNotSupport', - 'errorMessage' => 'Invalid probe port. Specify a valid port from 1 to 65535 for the probe request. Then, try again.', - 'description' => 'The incoming monitor listening port is not supported. The port value range is [1-65535]. Please ensure that the port is within the value range and try again.', - ], - [ - 'errorCode' => 'MonitorRetriesInvalid', - 'errorMessage' => 'Invalid number of probe retries. Specify an integer from 0 to 5. Then, try again.', - 'description' => 'Invalid number of probe retries. Specify an integer from 0 to 5. Then try again.', - ], - [ - 'errorCode' => 'MonitorTimeoutInvalid', - 'errorMessage' => 'Invalid timeout for the probe. Valid values are 1 to 10.', - 'description' => 'Invalid timeout for the probe. Valid values are 1 to 10.', - ], - [ - 'errorCode' => 'MonitorTypeNotSupport', - 'errorMessage' => 'Invalid protocol. Valid values are off, HTTP, HTTPS, TCP, UDP, ICMP Ping, and SMTP.', - 'description' => 'Invalid protocol. Valid values are off, HTTP, HTTPS, TCP, UDP, ICMP Ping, and 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' => 'The specified origin pool does not exist or does not belong to your account or website. Check and try again.', - ], - [ - 'errorCode' => 'LoadBalancerNameConflict', - 'errorMessage' => 'The load balancer name or the hostname for the origin pool already exists. Try again with a unique name.', - 'description' => 'The load balancer name or the hostname for the origin pool already exists. Try again with a unique name.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - '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' => '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.', - ], - [ - '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' => '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.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'LoadBalancerQuotaCheckFailed', 'errorMessage' => 'Load balancer enable quota check failed.', 'description' => 'Your current plan cannot use the load balancer related functions. If you need to use it, upgrade the plan.'], + ['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' => '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.'], + ['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' => '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.'], + ['errorCode' => 'LoadBalancerPolicyCheckFailed', 'errorMessage' => 'Your current plan does not support the load balancer scheduling policy. Upgrade the plan and try again.', 'description' => 'Your current plan does not support the load balancer scheduling policy. Upgrade the plan and try again.'], + ['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' => 'Your current plan does not allow you to configure the load balancer\'s health detection. Upgrade the plan and try again.'], + ['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' => '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.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'MonitorExpectedBodyInvalid', 'errorMessage' => 'Invalid response body. Specify a response body that does not exceed 102,400 characters in length in your custom rule.', 'description' => 'Invalid response body. Specify a response body that does not exceed 102,400 characters in length in your custom rule.'], + ['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' => '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.'], + ['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' => 'The incoming monitor is carrying an illegal request header. Make sure that the number of request headers does not exceed 10, that each request header has a value length between 1 and 10, and that you must not use the User-Agent request header (which is reserved for internal specific scenarios). In addition, the total length of all request headers and their values must not exceed 6000 characters. Please check and correct the request header configuration and try again.'], + ['errorCode' => 'MonitorMethodNotSupport', 'errorMessage' => 'Invalid HTTP method for the probe request. Valid values are GET and HEAD.', 'description' => 'Invalid HTTP method for the probe request. Valid values are GET and 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' => '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.'], + ['errorCode' => 'MonitorPortNotSupport', 'errorMessage' => 'Invalid probe port. Specify a valid port from 1 to 65535 for the probe request. Then, try again.', 'description' => 'The incoming monitor listening port is not supported. The port value range is [1-65535]. Please ensure that the port is within the value range and try again.'], + ['errorCode' => 'MonitorRetriesInvalid', 'errorMessage' => 'Invalid number of probe retries. Specify an integer from 0 to 5. Then, try again.', 'description' => 'Invalid number of probe retries. Specify an integer from 0 to 5. Then try again.'], + ['errorCode' => 'MonitorTimeoutInvalid', 'errorMessage' => 'Invalid timeout for the probe. Valid values are 1 to 10.', 'description' => 'Invalid timeout for the probe. Valid values are 1 to 10.'], + ['errorCode' => 'MonitorTypeNotSupport', 'errorMessage' => 'Invalid protocol. Valid values are off, HTTP, HTTPS, TCP, UDP, ICMP Ping, and SMTP.', 'description' => 'Invalid protocol. Valid values are off, HTTP, HTTPS, TCP, UDP, ICMP Ping, and 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' => 'The specified origin pool does not exist or does not belong to your account or website. Check and try again.'], + ['errorCode' => 'LoadBalancerNameConflict', 'errorMessage' => 'The load balancer name or the hostname for the origin pool already exists. Try again with a unique name.', 'description' => 'The load balancer name or the hostname for the origin pool already exists. Try again with a unique name.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['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' => '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.'], + ['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' => '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.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], ], 403 => [ - [ - 'errorCode' => 'QuotaExceeded', - 'errorMessage' => 'The quota is exceeded.', - 'description' => 'The quota is exceeded.', - ], + ['errorCode' => 'QuotaExceeded', 'errorMessage' => 'The quota is exceeded.', 'description' => 'The quota is exceeded.'], ], [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'Create Load Balancer', - 'summary' => 'Add a New Load Balancer', - 'description' => 'Through this API, users can configure load balancing services according to their business needs, including but not limited to adaptive routing, weighted round-robin, rule matching, health checks, and more, to achieve effective traffic management and optimization.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\\\n\\",\\n \\"Id\\": 0\\n}","type":"json"}]', + 'title' => 'Create a load balancer', + 'description' => 'Creates a load balancing service based on your business requirements. You can configure settings such as adaptive routing, weighted polling, rule matching, and health checks to effectively manage and optimize traffic.'."\n" + ."\n" + .'Only Enterprise plans support the load balancing service. To use this feature, contact Alibaba Cloud sales to apply for an Enterprise plan.', 'changeSet' => [ - [ - 'createdAt' => '2025-06-16T02:25:11.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2025-02-13T01:34:54.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2025-02-10T01:25:59.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-06-16T02:25:11.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-13T01:34:54.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-10T01:25:59.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateLoadBalancer', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLoadBalancer'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateLoadBalancer', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\\\n\\",\\n \\"Id\\": 0\\n}","type":"json"}]', ], 'CreateNetworkOptimization' => [ - 'summary' => 'Create a new site network optimization configuration', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Adds a network optimization configuration for a site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -13464,168 +6771,86 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '258000', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '340035003106221', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '340035003106221', 'title' => ''], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The version number of the site configuration. For sites with version management enabled, this parameter can specify the effective version of the configuration, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version on which the configuration takes effect. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. This parameter is not required when you add a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Possible values:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'The rule switch. This parameter is not required when you add a global configuration. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq \\"video.example.com\\")'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The rule content, which uses a conditional expression to match user requests. This parameter is not required when you add a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: set the value to true.'."\n" + .'- Match specified requests: set the value to a custom expression, such as (http.host eq \\"video.example.com\\").', 'type' => 'string', 'required' => false, 'example' => '(http.host eq \\"video.example.com\\")'."\n", 'title' => ''], ], [ 'name' => 'SmartRouting', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable smart routing service, disabled by default. Possible values:'."\n" - .'- on: Enable'."\n" - .'- off: Disable', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable smart routing. This feature is disabled by default. Valid values:'."\n" + .'- on: enabled'."\n" + .'- off: disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Http2Origin', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable HTTP2 origin, disabled by default. Possible values:'."\n" - .'- on: Enable'."\n" - .'- off: Disable', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable HTTP/2 back-to-origin. This feature is disabled by default. Valid values:'."\n" + .'- on: enabled'."\n" + .'- off: disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Websocket', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable Websocket, enabled by default. Possible values:'."\n" - .'- on: Enable'."\n" - .'- off: Disable', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable WebSocket. This feature is enabled by default. Valid values:'."\n" + .'- on: enabled'."\n" + .'- off: disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Grpc', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable GRPC, disabled by default. Possible values:'."\n" - .'- on: Enable'."\n" - .'- off: Disable', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable gRPC. This feature is disabled by default. Valid values:'."\n" + .'- on: enabled'."\n" + .'- off: disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'UploadMaxFilesize', 'in' => 'query', - 'schema' => [ - 'description' => 'Maximum upload file size in MB, range: 100～500.', - 'type' => 'string', - 'required' => false, - 'example' => '100', - 'title' => '', - ], + 'schema' => ['description' => 'The maximum upload file size, in MB. Valid values: 100 to 500.', 'type' => 'string', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule execution order. Rules with smaller numeric values are executed first.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - ], - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '352816096987136', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '352816096987136', 'title' => ''], ], 'example' => '', ], @@ -13633,150 +6858,44 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'Add Site Network Optimization Configuration', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"ConfigId\\": 352816096987136\\n}","type":"json"}]', + 'title' => 'Add site network optimization configuration', + 'description' => 'The site plan must be Standard Edition or higher to use the WebSocket feature. When calling this API, you must provide at least one feature configuration parameter. Providing only SiteId returns an error.', 'changeSet' => [ - [ - 'createdAt' => '2025-03-27T02:58:48.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-03-27T02:58:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateNetworkOptimization', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateNetworkOptimization'], ], ], 'ramActions' => [ @@ -13787,25 +6906,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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', - ], + 'summary' => 'Creates an origin pool for a site. You can then use the origin pool with a Server Load Balancer or for direct back-to-origin requests.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -13818,156 +6928,85 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238443', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the origin address pool, which must be unique within a site.', - 'type' => 'string', - 'required' => true, - 'example' => 'pool1', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the origin pool. The name must be unique within a site.', 'type' => 'string', 'required' => true, 'example' => 'pool1', 'title' => ''], ], [ 'name' => 'Enabled', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether the origin address pool is enabled:'."\n" - ."\n" - .'- true: Enabled;'."\n" - .'- false: Disabled.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether the origin pool is enabled.'."\n" + ."\n" + .'- `true`: enabled'."\n" + ."\n" + .'- `false`: disabled', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'Origins', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'Information about the origins added to the origin address pool, with multiple origins passed as an array.', + 'description' => 'The list of origins to add to the origin pool. Use an array to specify multiple origins.', 'type' => 'array', 'items' => [ - 'description' => 'Information about a single origin.', + 'description' => 'The configuration for a single origin.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the origin, which must be unique within an origin address.', - 'type' => 'string', - 'required' => false, - 'example' => 'origin1', - 'title' => '', - ], - 'Address' => [ - 'description' => 'The address of the origin, e.g., www.example.com.', - 'type' => 'string', - 'required' => false, - 'example' => 'www.example.com', - 'title' => '', - ], - 'Enabled' => [ - 'description' => 'Whether the origin is enabled:'."\n" - ."\n" - .'- true: Enabled;'."\n" - .'- false: Disabled.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], - 'Header' => [ - 'description' => 'The request header to be included when fetching from the origin, only Host is supported.', - 'type' => 'any', - 'required' => false, - 'example' => '{'."\n" - .' "Host": ['."\n" - .' "example.com"'."\n" - .' ]'."\n" - .' }', - 'title' => '', - ], - 'Weight' => [ - 'description' => 'The weight, an integer between 0 and 100.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The type of the origin:'."\n" - ."\n" - .'- ip_domain: IP or domain name type origin;'."\n" - .'- OSS: OSS address origin;'."\n" - .'- S3: AWS S3 origin.', - 'type' => 'string', - 'required' => false, - 'example' => 'ip_domain', - 'title' => '', - ], + 'Name' => ['description' => 'The name of the origin. The name must be unique within the origin pool.', 'type' => 'string', 'required' => false, 'example' => 'origin1', 'title' => ''], + 'Address' => ['description' => 'The address of the origin. For example, www\\.example.com.', 'type' => 'string', 'required' => false, 'example' => 'www.example.com', 'title' => ''], + 'Enabled' => ['description' => 'Specifies whether the origin is enabled.'."\n" + ."\n" + .'- `true`: enabled'."\n" + ."\n" + .'- `false`: disabled', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'Header' => ['description' => 'The request header to include in back-to-origin requests. Only the `Host` header is supported.', 'type' => 'any', 'required' => false, 'example' => '{'."\n" + .' "Host": ['."\n" + .' "example.com"'."\n" + .' ]'."\n" + .' }', 'title' => ''], + 'Weight' => ['description' => 'The weight of the origin. The value must be an integer from 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], + 'Type' => ['description' => 'The type of the origin. Valid values:'."\n" + ."\n" + .'- `ip_domain`: An IP address or a domain name.'."\n" + ."\n" + .'- `OSS`: An Alibaba Cloud OSS bucket.'."\n" + ."\n" + .'- `S3`: An AWS S3 bucket.', 'type' => 'string', 'required' => false, 'example' => 'ip_domain', 'title' => ''], 'AuthConf' => [ - 'description' => 'Authentication information, required when the origin is OSS or S3 and needs authentication, including related configuration details.', + 'description' => 'The authentication configuration for the origin. Required if the origin is an OSS or AWS S3 bucket that requires authentication.', 'type' => 'object', 'properties' => [ - 'AuthType' => [ - 'description' => 'The type of authentication.'."\n" - ."\n" - .'- public: Public read/write, used when the origin is OSS or S3 and is set to public read/write;'."\n" - .'- private_same_account: Private same account, used when the origin is OSS and the authentication type is private within the same account;'."\n" - .'- private_cross_account: Private cross-account, used when the origin is OSS and the authentication type is private across accounts;'."\n" - .'- private: Used when the origin is S3 and the authentication type is private.', - 'type' => 'string', - 'required' => false, - 'example' => 'public', - 'title' => '', - ], - 'AccessKey' => [ - 'description' => 'The access key required for private authentication.', - 'type' => 'string', - 'required' => false, - 'example' => 'yourAccessKeyID', - 'title' => '', - ], - 'SecretKey' => [ - 'description' => 'The secret key required for private authentication.', - 'type' => 'string', - 'required' => false, - 'example' => 'yourAccessKeySecret', - 'title' => '', - ], - 'Version' => [ - 'description' => 'The signature version required when the origin is AWS S3.', - 'type' => 'string', - 'required' => false, - 'example' => 'v2', - 'title' => '', - ], - 'Region' => [ - 'description' => 'The region of the origin required when the origin is AWS S3.', - 'type' => 'string', - 'required' => false, - 'example' => 'us-east-1', - 'title' => '', - ], + 'AuthType' => ['description' => 'The authentication type. Valid values:'."\n" + ."\n" + .'- `public`: Public read/write. Use this for public OSS or AWS S3 buckets.'."\n" + ."\n" + .'- `private_same_account`: Private authentication for an OSS bucket in the same Alibaba Cloud account.'."\n" + ."\n" + .'- `private_cross_account`: Private authentication for an OSS bucket in a different Alibaba Cloud account.'."\n" + ."\n" + .'- `private`: Private authentication for an AWS S3 bucket.', 'type' => 'string', 'required' => false, 'example' => 'public', 'title' => ''], + 'AccessKey' => ['description' => 'The access key required for private authentication.', 'type' => 'string', 'required' => false, 'example' => 'yourAccessKeyID', 'title' => ''], + 'SecretKey' => ['description' => 'The secret key required for private authentication.', 'type' => 'string', 'required' => false, 'example' => 'yourAccessKeySecret', 'title' => ''], + 'Version' => ['description' => 'The signature version. Required for AWS S3 origins.', 'type' => 'string', 'required' => false, 'example' => 'v2', 'title' => ''], + 'Region' => ['description' => 'The region of the origin. Required for AWS S3 origins.', 'type' => 'string', 'required' => false, 'example' => 'us-east-1', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], - 'IpVersionPolicy' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'IpVersionPolicy' => ['description' => 'The IP protocol version for back-to-origin requests. Valid values:'."\n" + ."\n" + .'- `round_robin`: Default. Randomly selects an IPv4 or IPv6 origin.'."\n" + ."\n" + .'- `ipv4_first`: Prioritizes IPv4 origins.'."\n" + ."\n" + .'- `ipv6_first`: Prioritizes IPv6 origins.'."\n" + ."\n" + .'- `follow`: Uses the same IP protocol version as the client\'s request.', 'type' => 'string', 'required' => false, 'example' => 'round_robin', 'title' => ''], ], 'required' => false, 'title' => '', @@ -13981,36 +7020,18 @@ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '21655860979****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. To obtain this ID, call the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '21655860979****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'."\n", - ], - 'Id' => [ - 'description' => 'The ID of the newly created origin address pool.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '103852052519****', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'."\n"], + 'Id' => ['description' => 'The origin pool ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '103852052519****', 'title' => ''], ], 'example' => '', ], @@ -14018,112 +7039,58 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'SourceNumberExceedLimit', - 'errorMessage' => 'The number of sources in the origin pool exceeds the quota limit.', - 'description' => 'The number of sources that can be created in the origin pool has reached the upper limit of the package. Please check your package quota and upgrade the package to obtain more quota.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter.AddressConflict', - 'errorMessage' => 'Duplicate origin addresses. Make sure that each origin address for the same pool is unique.', - 'description' => 'Duplicate origin addresses. Make sure that each origin address for the same pool is unique.', - ], - [ - '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' => 'The specified origin pool name already exists or its hostname conflicts with a load balancer name. Try again with a unique name.', - ], - [ - 'errorCode' => 'SourceAddressInvalid', - 'errorMessage' => 'Invalid origin address. Check whether the IP address or domain name is in the valid format.', - 'description' => 'Invalid origin address. Check whether the IP address or domain name is in the valid format.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'SourceInBlackList', - 'errorMessage' => 'The source is in the black list.', - 'description' => 'The source is in the black list.', - ], - [ - 'errorCode' => 'InvalidParameter.PrivateIpAsSourceUnsupported', - 'errorMessage' => 'The provided origin is an invalid private IP address. Please verify and resubmit.', - 'description' => 'The provided origin is an invalid private IP address. Please verify and resubmit.', - ], - [ - 'errorCode' => 'InvalidParameter.SourceIpInBlacklist', - 'errorMessage' => 'The provided origin is an invalid private IP address. Please verify and resubmit.', - 'description' => 'The provided origin is an invalid private IP address. Please verify and resubmit.', - ], - [ - 'errorCode' => 'OriginPool.TypeNotSupport', - 'errorMessage' => 'The origin address pool type is not supported.', - 'description' => 'The origin address pool type is not supported.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'SourceNumberExceedLimit', 'errorMessage' => 'The number of sources in the origin pool exceeds the quota limit.', 'description' => 'The number of sources that can be created in the origin pool has reached the upper limit of the package. Please check your package quota and upgrade the package to obtain more quota.'], + ['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' => '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.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.AddressConflict', 'errorMessage' => 'Duplicate origin addresses. Make sure that each origin address for the same pool is unique.', 'description' => 'Duplicate origin addresses. Make sure that each origin address for the same pool is unique.'], + ['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' => 'The specified origin pool name already exists or its hostname conflicts with a load balancer name. Try again with a unique name.'], + ['errorCode' => 'SourceAddressInvalid', 'errorMessage' => 'Invalid origin address. Check whether the IP address or domain name is in the valid format.', 'description' => 'Invalid origin address. Check whether the IP address or domain name is in the valid format.'], + ['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' => '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.'], + ['errorCode' => 'SourceInBlackList', 'errorMessage' => 'The source is in the black list.', 'description' => 'The source is in the black list.'], + ['errorCode' => 'InvalidParameter.PrivateIpAsSourceUnsupported', 'errorMessage' => 'The provided origin is an invalid private IP address. Please verify and resubmit.', 'description' => 'The provided origin is an invalid private IP address. Please verify and resubmit.'], + ['errorCode' => 'InvalidParameter.SourceIpInBlacklist', 'errorMessage' => 'The provided origin is an invalid private IP address. Please verify and resubmit.', 'description' => 'The provided origin is an invalid private IP address. Please verify and resubmit.'], + ['errorCode' => 'OriginPool.TypeNotSupport', 'errorMessage' => 'The origin address pool type is not supported.', 'description' => 'The origin address pool type is not supported.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\\\n\\",\\n \\"Id\\": 0\\n}","type":"json"}]', 'title' => 'Create Origin Address Pool', - 'summary' => 'Add a new origin address pool', - 'description' => 'Multiple origins can be added under the origin address, supporting domain names, IPs, OSS, S3, and other types of origins. It supports authentication for OSS and S3 type origins.', + 'description' => 'You can add multiple origins to an origin pool, such as a domain name, IP, OSS, or S3. Back-to-origin authentication is available for OSS and S3 origins.', 'changeSet' => [ - [ - 'createdAt' => '2025-05-20T11:43:19.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-05-20T11:43:19.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateOriginPool', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOriginPool'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateOriginPool', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\\\n\\",\\n \\"Id\\": 0\\n}","type":"json"}]', ], 'CreateOriginProtection' => [ 'summary' => 'Enables origin protection.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -14136,52 +7103,39 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '250009', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4VDL9A', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4VDL9A'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) operation. The plan associated with the site must support the origin protection feature.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'AutoConfirmIPList', 'in' => 'query', 'schema' => [ + 'title' => '', + 'description' => 'Specifies whether to automatically enable the latest back-to-origin IP addresses list. Valid values:'."\n" + .'- off: Do not automatically enable.'."\n" + .'- on: Automatically enable.', + 'enumValueTitles' => ['off' => 'not automatically enabled.', 'on' => 'automatically enabled.'], 'type' => 'string', 'example' => 'off', 'default' => 'off', - 'enum' => [ - 'on', - 'off', - ], - 'title' => '', - 'description' => '', + 'enum' => ['on', 'off'], + 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'], ], 'example' => '', ], @@ -14189,66 +7143,45 @@ ], '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - '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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'CreateOriginProtection', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\"\\n}","type":"json"}]', + 'title' => 'Enable origin protection', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '5', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateOriginProtection', + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOriginProtection'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateOriginProtection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\"\\n}","type":"json"}]', ], 'CreateOriginRule' => [ - 'summary' => 'Create a new origin rule configuration for the site', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Create a Back-to-Origin Rule for a Site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -14261,301 +7194,177 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '258002', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '340035003106221', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the site. You can obtain this ID by calling the [ListSites](~~ListSites~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '340035003106221', 'title' => ''], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the version of the site where the configuration takes effect. The default is version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'For sites with version management enabled, this specifies the version to which the configuration applies. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. This parameter is not required when adding global configurations.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. Not required when creating a Global Configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule switch. This parameter is not required when adding global configurations. Possible values:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable the rule. Not required when creating a Global Configuration. Valid values:'."\n" + ."\n" + .'- `on`: Enables the rule.'."\n" + ."\n" + .'- `off`: Disables the rule.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding global configurations. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq \\"video.example.com\\")'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The content of the rule, a Conditional Expression that matches user requests. Not required when creating a Global Configuration. There are two scenarios:'."\n" + ."\n" + .'- To match all incoming requests, set the value to `true`.'."\n" + ."\n" + .'- To match specific requests, set the value to a custom expression. Example: `(http.host eq "video.example.com")`.', 'type' => 'string', 'required' => false, 'example' => '(http.host eq \\"video.example.com\\")'."\n", 'title' => ''], ], [ 'name' => 'OriginHost', 'in' => 'query', - 'schema' => [ - 'description' => 'The HOST carried in the origin request.', - 'type' => 'string', - 'required' => false, - 'example' => 'origin.example.com'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The `Host` header to use in Origin requests.', 'type' => 'string', 'required' => false, 'example' => 'origin.example.com'."\n", 'title' => ''], ], [ 'name' => 'OriginScheme', 'in' => 'query', - 'schema' => [ - 'description' => 'Protocol used for the origin request. Possible values:'."\n" - .'- http: Use HTTP protocol for origin requests.'."\n" - .'- https: Use HTTPS protocol for origin requests.'."\n" - .'- follow: Follow the client\'s protocol for origin requests.', - 'type' => 'string', - 'required' => false, - 'example' => 'http', - 'title' => '', - ], + 'schema' => ['description' => 'The protocol for Origin requests. Valid values:'."\n" + ."\n" + .'- `http`: Uses the HTTP protocol.'."\n" + ."\n" + .'- `https`: Uses the HTTPS protocol.'."\n" + ."\n" + .'- `follow`: Uses the same protocol as the client request.', 'type' => 'string', 'required' => false, 'example' => 'http', 'title' => ''], ], [ 'name' => 'OriginSni', 'in' => 'query', - 'schema' => [ - 'description' => 'SNI carried in the origin request.', - 'type' => 'string', - 'required' => false, - 'example' => 'origin.example.com', - 'title' => '', - ], + 'schema' => ['description' => 'The Server Name Indication (SNI) to use in Origin requests.', 'type' => 'string', 'required' => false, 'example' => 'origin.example.com', 'title' => ''], ], [ 'name' => 'DnsRecord', 'in' => 'query', - 'schema' => [ - 'description' => 'Rewrite the DNS resolution record for the origin request.', - 'type' => 'string', - 'required' => false, - 'example' => 'test.example.com'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'Overrides the DNS Record for Origin requests.', 'type' => 'string', 'required' => false, 'example' => 'test.example.com'."\n", 'title' => ''], ], [ 'name' => 'OriginHttpPort', 'in' => 'query', - 'schema' => [ - 'description' => 'Port of the origin server when using the HTTP protocol for origin requests.', - 'type' => 'string', - 'required' => false, - 'example' => '8080', - 'title' => '', - ], + 'schema' => ['description' => 'The Origin Port to use for HTTP Origin requests.', 'type' => 'string', 'required' => false, 'example' => '8080', 'title' => ''], ], [ 'name' => 'OriginHttpsPort', 'in' => 'query', - 'schema' => [ - 'description' => 'Port of the origin server when using the HTTPS protocol for origin requests.', - 'type' => 'string', - 'required' => false, - 'example' => '4433', - 'title' => '', - ], + 'schema' => ['description' => 'The Origin Port to use for HTTPS Origin requests.', 'type' => 'string', 'required' => false, 'example' => '4433', 'title' => ''], ], [ 'name' => 'Range', 'in' => 'query', - 'schema' => [ - 'description' => 'Use range chunking for origin downloads. Possible values:'."\n" - .'- on: Enable'."\n" - .'- off: Disable'."\n" - .'- force: Force', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to use range requests to download files from the Origin. Valid values:'."\n" + ."\n" + .'- `on`: Enables range requests.'."\n" + ."\n" + .'- `off`: Disables range requests.'."\n" + ."\n" + .'- `force`: Forces range requests.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'OriginMtls', 'in' => 'query', - 'schema' => [ - 'description' => 'mTLS switch. Possible values:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable mutual Transport Layer Security (mTLS) for Origin connections. Valid values:'."\n" + ."\n" + .'- `on`: Enables mTLS.'."\n" + ."\n" + .'- `off`: Disables mTLS.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'OriginVerify', 'in' => 'query', - 'schema' => [ - 'description' => 'Origin certificate verification switch. Possible values:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable Origin Certificate Verification. Valid values:'."\n" + ."\n" + .'- `on`: Enables verification.'."\n" + ."\n" + .'- `off`: Disables verification.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'RangeChunkSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Range shard size. Valid values:'."\n" - .'- 512 KB'."\n" - .'- 1 MB'."\n" - .'- 2 MB'."\n" - .'- 4 MB', - 'type' => 'string', - 'required' => false, - 'example' => '1MB', - 'title' => '', - ], + 'schema' => ['description' => 'The size of each chunk for range requests. Valid values:'."\n" + ."\n" + .'- `512KB`'."\n" + ."\n" + .'- `1MB`'."\n" + ."\n" + .'- `2MB`'."\n" + ."\n" + .'- `4MB`', 'type' => 'string', 'required' => false, 'example' => '1MB', 'title' => ''], ], [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule execution order. Rules with smaller numeric values are executed first.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The priority of the rule. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'OriginReadTimeout', 'in' => 'query', - 'schema' => [ - 'description' => 'Origin read timeout (seconds).', - 'type' => 'string', - 'required' => false, - 'example' => '10', - 'title' => '', - ], + 'schema' => ['description' => 'The Origin read timeout in seconds.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'Follow302Enable', 'in' => 'query', - 'schema' => [ - 'description' => '302 redirection toggle for origin fetch. Valid values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to follow 302 redirects from the Origin. Valid values:'."\n" + ."\n" + .'- `on`: Enables following redirects.'."\n" + ."\n" + .'- `off`: Disables following redirects.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Follow302MaxTries', 'in' => 'query', - 'schema' => [ - 'description' => 'Maximum number of 302 redirect attempts. Valid values: [1–5].', - 'type' => 'string', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The maximum number of 302 redirects to follow. Valid range: 1 to 5.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'Follow302RetainArgs', 'in' => 'query', - 'schema' => [ - 'description' => 'Toggle to retain original request parameters. Valid values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to retain the original request parameters when following a 302 redirect. Valid values:'."\n" + ."\n" + .'- `on`: Retains the request parameters.'."\n" + ."\n" + .'- `off`: Does not retain the request parameters.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Follow302RetainHeader', 'in' => 'query', - 'schema' => [ - 'description' => 'Toggle to retain original request headers. Valid values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to retain the original request header when following a 302 redirect. Valid values:'."\n" + ."\n" + .'- `on`: Retains the request header.'."\n" + ."\n" + .'- `off`: Does not retain the request header.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Follow302TargetHost', 'in' => 'query', - 'schema' => [ - 'description' => 'Modify the origin host after a 302 redirect.', - 'type' => 'string', - 'required' => false, - 'example' => 'test.com', - 'title' => '', - ], + 'schema' => ['description' => 'The Origin `Host` header to use after a 302 redirect.', 'type' => 'string', 'required' => false, 'example' => 'test.com', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - ], - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '352816096987136', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'], + 'ConfigId' => ['description' => 'The ID of the configuration.', 'type' => 'integer', 'format' => 'int64', 'example' => '352816096987136', 'title' => ''], ], 'example' => '', ], @@ -14563,185 +7372,68 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], 'title' => 'Add Origin Rule Configuration for Site', 'changeSet' => [ - [ - 'createdAt' => '2025-04-17T08:47:33.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2025-04-01T01:57:04.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2025-03-27T02:58:48.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2025-03-20T05:57:46.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2025-02-27T09:16:40.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-04-17T08:47:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-01T01:57:04.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-27T02:58:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-20T05:57:46.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-27T09:16:40.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateOriginRule', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOriginRule'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateOriginRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"ConfigId\\": 352816096987136\\n}","type":"json"}]', ], 'CreatePage' => [ - 'summary' => 'Creates a custom error page, which is displayed when a request is blocked by Web Application Firewall (WAF). You can configure the HTML content, page type, and description, and submit the Base64-encoded page content.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Creates a custom error response page. When a user request is blocked by Web Application Firewall (WAF), these custom error pages can be displayed. You can configure the page HTML content, page type, description, and other information, and submit the page content in BASE64 encoding.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -14754,80 +7446,80 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239648', - 'abilityTreeNodes' => [ - 'FEATUREdcdnL8HX1L', - ], + 'abilityTreeNodes' => ['FEATUREdcdnL8HX1L'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the custom error page.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'example', - ], + 'schema' => ['title' => '', 'description' => 'The name of the custom page.'."\n" + ."\n" + .'**Naming suggestions**: Use a short name that consists of letters, digits, and underscores, such as `blocked_page_v1`, for easy reference in rules. The specific character set, maximum length, uniqueness, and other constraints are **subject to the server-side custom page naming specifications**.', 'type' => 'string', 'required' => true, 'example' => 'example'], ], [ 'name' => 'Description', 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => 'The description of the page.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a custom deny page', - ], + 'schema' => ['title' => '', 'description' => 'The description of the page, used to identify the purpose of the page in the console list.'."\n" + ."\n" + .'**Suggested content**: Use the scenarios and identity information of the page, such as "CC protection block page - Chinese version". This is an optional field. If not specified, the value is empty by default.'."\n" + ."\n" + .'> The maximum field length is subject to the server-side specifications.', 'type' => 'string', 'example' => 'a custom deny page', 'required' => false], ], [ 'name' => 'ContentType', 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => 'The Content-Type field in the HTTP header. Valid values:'."\n" - ."\n" - .'* text/html'."\n" - .'* application/json'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'text/html', - ], + 'schema' => ['title' => '', 'description' => 'The MIME type of the page content. This value is returned to the client as the HTTP `Content-Type` response header after a match.'."\n" + ."\n" + .'**Common values**:'."\n" + .'- `text/html`: HTML page. The `Content` parameter must be set to the BASE64-encoded value of UTF-8 HTML text.'."\n" + .'- `application/json`: JSON response. The `Content` parameter must be set to the BASE64-encoded value of a valid JSON string.'."\n" + .'- `text/plain`: plain text. The `Content` parameter must be set to the BASE64-encoded value of plain text content.'."\n" + ."\n" + .'> Note: The complete list of supported ContentType values is subject to the server-side specifications. If the specified `ContentType` does not match the actual format of `Content`, the client may fail to render the page properly.', 'type' => 'string', 'required' => true, 'example' => 'text/html'], ], [ 'name' => 'Content', 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The BASE64-encoded page content. The actual content format must match the value of `ContentType`.'."\n" + ."\n" + .'**Encoding method**:'."\n" + .'1. Encode the original page content into a byte string by using UTF-8 encoding.'."\n" + .'2. Apply standard BASE64 encoding to the byte string.'."\n" + ."\n" + .'**Example**:'."\n" + .'- Original content: `hello page`'."\n" + .'- BASE64: `PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=`'."\n" + ."\n" + .'> The maximum size, supported character sets, and security filtering rules are subject to the server-side custom page specifications.', 'type' => 'string', 'required' => false, 'example' => 'PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4='], + ], + [ + 'name' => 'SiteIds', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ 'title' => '', - 'description' => 'The Base64-encoded page content. Example: "PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=", which indicates "hello page".'."\n", - 'type' => 'string', + 'description' => 'The list of website IDs to associate with this custom page.'."\n" + ."\n" + .'- You can obtain website IDs by calling the `ListSites` operation.'."\n" + .'- If you pass an empty list (no websites are associated), the page is still created but does not take effect. You can call the `UpdatePage` operation later to associate websites.'."\n" + .'- If the list contains a website ID that does not belong to the current account, an `InvalidParameter` error is returned.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The associated website ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], 'required' => false, - 'example' => 'PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], - 'Id' => [ - 'title' => '', - 'description' => 'The ID of the custom error page.[](~~2850223~~)'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50000001', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], + 'Id' => ['title' => '', 'description' => 'The ID of the custom response page. You can obtain the ID by calling the [ListPages](~~2850223~~) operation.', 'type' => 'integer', 'format' => 'int64', 'example' => '50000001'], ], 'example' => '', ], @@ -14835,58 +7527,26 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], 403 => [ - [ - 'errorCode' => '%s.NotSupport', - 'errorMessage' => 'The specified resource type %s is not supported.', - 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.', - ], - [ - 'errorCode' => '%s.OverQuota', - 'errorMessage' => 'The quantity of %s exceeds the quota.', - 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.', - ], - [ - 'errorCode' => '%s.WrongValueMatched', - 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', - 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.', - ], + ['errorCode' => '%s.NotSupport', 'errorMessage' => 'The specified resource type %s is not supported.', 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.'], + ['errorCode' => '%s.OverQuota', 'errorMessage' => 'The quantity of %s exceeds the quota.', 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.'], + ['errorCode' => '%s.WrongValueMatched', 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.'], + ['errorCode' => 'Page.SiteAlreadyBound', 'errorMessage' => 'The specified site has already been associated with another custom error page of the same type. Dissociate the site from the existing page and try again.', 'description' => 'The specified site is already bound to another custom response page of the same type. Please first unbind the site from the existing page and then try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Id\\": 50000001\\n}","type":"json"}]', - 'title' => 'CreatePage', + 'title' => 'Create a custom response page', 'changeSet' => [ - [ - 'createdAt' => '2024-09-25T07:02:49.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T09:53:47.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-25T07:02:49.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T09:53:47.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreatePage', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePage'], ], ], 'ramActions' => [ @@ -14897,25 +7557,16 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CreateRecord' => [ - 'summary' => 'Creates a DNS record for a specific website.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Create a DNS record under a site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -14928,240 +7579,99 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239598', - 'abilityTreeNodes' => [ - 'FEATUREdcdnVFT29S', - ], + 'abilityTreeNodes' => ['FEATUREdcdnVFT29S'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'RecordName', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '', - 'description' => 'The record name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'www.example.com', - ], + 'schema' => ['title' => '', 'description' => 'The record name.', 'type' => 'string', 'required' => true, 'example' => 'www.example.com'], ], [ 'name' => 'Proxied', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '', - 'description' => 'Specifies whether to proxy the record. Only CNAME and A/AAAA records can be proxied. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['title' => '', 'description' => 'Specifies whether to enable proxy acceleration for the record. Only CNAME records or A/AAAA records (i.e., when the type parameter is set to A/AAAA or CNAME) can enable proxy acceleration. Valid values:'."\n" + .'- **true**: Enable proxy acceleration.'."\n" + .'- **false**: Disable proxy acceleration.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'Type', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '', - 'description' => 'The type of the DNS record. For example, A/AAAA, TXT, MX, or CNAME.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'A/AAAA', - ], + 'schema' => ['title' => '', 'description' => 'The DNS type of the record, such as **A/AAAA**, **CNAME**, **TXT**, etc.', 'type' => 'string', 'required' => true, 'example' => 'A/AAAA'], ], [ 'name' => 'SourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The origin type for the CNAME record. This parameter is required when you add a CNAME record. Valid values:'."\n" - ."\n" - .'* **OSS**: OSS bucket.'."\n" - .'* **S3**: S3 bucket.'."\n" - .'* **LB**: load balancer.'."\n" - .'* **OP**: origin pool.'."\n" - .'* **Domain**: domain name.'."\n" - ."\n" - .'If you do not pass this parameter or if you leave its value empty, Domain is used by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OSS', - 'title' => '', - ], + 'schema' => ['description' => 'The origin type of the CNAME record. This parameter is required when adding a CNAME record (i.e., when the type parameter is set to CNAME). Valid values:'."\n" + ."\n" + .'- **OSS**: OSS origin.'."\n" + .'- **S3**: S3 origin.'."\n" + .'- **LB**: Load balancer origin.'."\n" + .'- **OP**: Origin pool origin.'."\n" + .'- **Domain**: Standard domain origin.'."\n" + ."\n" + .'If this parameter is not specified or is left empty, it defaults to Domain, which is the standard domain origin type.', 'type' => 'string', 'required' => false, 'example' => 'OSS', 'title' => ''], ], [ 'name' => 'BizName', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '', - 'description' => 'The business scenario of the record for acceleration. Leave the parameter empty if your record is not proxied. Valid values:'."\n" - ."\n" - .'* **image_video**: video and image.'."\n" - .'* **api**: API.'."\n" - .'* **web**: web page.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'web', - ], + 'schema' => ['title' => '', 'description' => 'Used to tag the business scenario of the DNS record. This parameter is required when proxy acceleration is enabled for the DNS record (i.e., when the proxied parameter is set to true), and is not required when proxy acceleration is disabled (i.e., when the proxied parameter is set to false). Valid values:'."\n" + .'- **image_video**: Image and video.'."\n" + .'- **api**: API.'."\n" + .'- **web**: Web page.', 'type' => 'string', 'required' => false, 'example' => 'web'], ], [ 'name' => 'Ttl', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The TTL of the record. Unit: seconds. If the value is 1, the TTL of the record is determined by the system.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '30', - 'title' => '', - ], + 'schema' => ['description' => 'The time-to-live (TTL) of the record, in seconds. When set to 1, the TTL is automatic.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '30', 'title' => ''], ], [ 'name' => 'Data', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The DNS record information. The format of this field varies based on the record type. For more information, see [References](https://www.alibabacloud.com/help/doc-detail/2708761.html) .'."\n", - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'Record value or part of the record content. This parameter is required when you add A/AAAA, CNAME, NS, MX, TXT, CAA, SRV, and URI records. It has different meanings based on types of records:'."\n" - ."\n" - .'* **A/AAAA**: the IP address(es). Separate IP addresses with commas (,). You must have at least one IPv4 address.'."\n" - .'* **CNAME**: the target domain name.'."\n" - .'* **NS**: the name servers for the domain name.'."\n" - .'* **MX**: a valid domain name of the target mail server.'."\n" - .'* **TXT**: a valid text string.'."\n" - .'* **CAA**: a valid domain name of the certificate authority.'."\n" - .'* **SRV**: a valid domain name of the target host.'."\n" - .'* **URI**: a valid URI string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'example.com', - 'title' => '', - ], - 'Priority' => [ - 'description' => 'The priority of the record, specified within the range of 0 to 65,535. A smaller value indicates a higher priority. This parameter is required when you add MX, SRV, and URI records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'title' => '', - ], - 'Flag' => [ - 'description' => 'The flag bit of the record. The Flag for a CAA record indicates its priority and how it is processed, specified within the range of 0 to 255. This parameter is required when you add a CAA record.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '128', - 'title' => '', - ], - 'Tag' => [ - 'description' => 'The label of the record. The Tag of a CAA record indicate its specific type and usage. This parameter is required when you add a CAA record. Valid values:'."\n" - ."\n" - .'* **issue**: indicates that a CA is authorized to issue a certificate for the domain name. This is usually followed by the domain name of the CA.'."\n" - .'* **issuewild**: indicates that a CA is authorized to issue a wildcard certificate (such as \\*.example.com) for the domain name.'."\n" - .'* **iodef**: specifies a URI to receive reports about CAA record violations.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'issue', - 'title' => '', - ], - 'Weight' => [ - 'description' => 'The weight of the record, specified within the range of 0 to 65,535. This parameter is required when you add SRV or URI records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], - 'Port' => [ - 'description' => 'The port of the record, specified within the range of 0 to 65,535. This parameter is required when you add an SRV record.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The certificate type of the record (in CERT records), or the public key type (in SSHFP records). This parameter is required when you add CERT or SSHFP records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => 'RSA', - 'title' => '', - ], - 'KeyTag' => [ - 'description' => 'The public key identification for the record, specified within the range of 0 to 65,535. This parameter is required when you add a CAA record.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], - 'Algorithm' => [ - 'description' => 'The encryption algorithm used for the record, specified within the range from 0 to 255. This parameter is required when you add CERT or SSHFP records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], - 'Certificate' => [ - 'description' => 'The public key of the certificate. This parameter is required when you add CERT, SMIMEA, or TLSA records.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dGVzdGFkYWxrcw==', - 'title' => '', - ], - 'Usage' => [ - 'description' => 'The usage identifier of the record, specified within the range of 0 to 255. This parameter is required when you add SMIMEA or TLSA records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], - 'Selector' => [ - 'description' => 'The type of certificate or public key, specified within the range of 0 to 255. This parameter is required when you add SMIMEA or TLSA records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], - 'MatchingType' => [ - 'description' => 'The algorithm policy used to match or validate the certificate, specified within the range 0 to 255. This parameter is required when you add SMIMEA or TLSA records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], - 'Fingerprint' => [ - 'description' => 'The public key fingerprint of the record. This parameter is required when you add a SSHFP record.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abcdef1234567890', - 'title' => '', - ], + 'description' => 'The DNS information of the record. Different types of records require different content for this field. For more information, see'."\n" + .'[Documentation](~~2708761~~)[Documentation](https://www.alibabacloud.com/help/doc-detail/2708761.html)'."\n" + .'.', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The record value or partial content. This parameter is required when the record type is A/AAAA, CNAME, NS, MX, TXT, CAA, SRV, or URI. It represents different meanings for different record types:'."\n" + ."\n" + .'- **A/AAAA**: The IP address to point to. Multiple IPs are separated by commas (,). At least one IPv4 address is required.'."\n" + .'- **CNAME**: The target domain name to point to.'."\n" + .'- **NS**: The name server for the specified domain.'."\n" + .'- **MX**: A valid target mail server domain name.'."\n" + .'- **TXT**: A valid text string.'."\n" + .'- **CAA**: A valid certificate authority domain name.'."\n" + .'- **SRV**: A valid target host domain name.'."\n" + .'- **URI**: A valid URI string.', 'type' => 'string', 'required' => false, 'example' => 'example.com', 'title' => ''], + 'Priority' => ['description' => 'The priority of the record, ranging from **0 to 65535**. A smaller value indicates a higher priority. This parameter is required when adding MX, SRV, or URI records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + 'Flag' => ['description' => 'The flag of the record. The Flag of a CAA record indicates its priority and processing method, with a value range of **0 to 255**. This parameter is required when adding a CAA record.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '128', 'title' => ''], + 'Tag' => ['description' => 'The tag of the record. The Tag of a CAA record indicates its specific type and purpose. This parameter is required when adding a CAA record. Valid values for Tag:'."\n" + .'- **issue**: Authorizes a specific CA to issue certificates for the domain. It is usually followed by the CA\'s domain name.'."\n" + .'- **issuewild**: Authorizes a specific CA to issue wildcard certificates for the domain (e.g., *.example.com).'."\n" + .'- **iodef**: Specifies a URI for receiving reports about violations of CAA records.', 'type' => 'string', 'required' => false, 'example' => 'issue', 'title' => ''], + 'Weight' => ['description' => 'The weight of the record, ranging from **0 to 65535**. This parameter is required when adding SRV or URI records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'Port' => ['description' => 'The port of the record, ranging from **0 to 65535**. This parameter is required when adding an SRV record.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'Type' => ['description' => 'The certificate type of the record (for CERT records) or the public key type (for SSHFP records). This parameter is required when adding CERT or SSHFP records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'KeyTag' => ['description' => 'The public key identifier of the record, ranging from **0 to 65535**. This parameter is required when adding a CERT record.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'Algorithm' => ['description' => 'The encryption algorithm used by the record, ranging from **0 to 255**. This field is required when adding CERT or SSHFP records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'Certificate' => ['description' => 'The public key certificate information of the record. This parameter is required when adding CERT, SMIMEA, or TLSA records.', 'type' => 'string', 'required' => false, 'example' => 'dGVzdGFkYWxrcw==', 'title' => ''], + 'Usage' => ['description' => 'The usage identifier of the record, ranging from **0 to 255**. This parameter is required when adding SMIMEA or TLSA records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'Selector' => ['description' => 'The type of certificate or public key used by the record, ranging from **0 to 255**. This parameter is required when adding SMIMEA or TLSA records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'MatchingType' => ['description' => 'The algorithm policy used by the record to match or verify certificates, ranging from **0 to 255**. This parameter is required when adding SMIMEA or TLSA records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'Fingerprint' => ['description' => 'The public key fingerprint value of the record. This parameter is required when adding an SSHFP record.', 'type' => 'string', 'required' => false, 'example' => 'abcdef1234567890', 'title' => ''], ], 'required' => true, 'example' => '{'."\n" @@ -15173,67 +7683,29 @@ [ 'name' => 'Comment', 'in' => 'query', - 'schema' => [ - 'description' => 'The comment of the record. The maximum length is 100 characters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'This is a remark.', - 'title' => '', - ], + 'schema' => ['description' => 'The comment for the record, with a maximum length of 100 characters.', 'type' => 'string', 'required' => false, 'example' => 'This is a remark.', 'title' => ''], ], [ 'name' => 'AuthConf', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The origin authentication information of the CNAME record.'."\n", + 'description' => 'The origin authentication information for the CNAME record.', 'type' => 'object', 'properties' => [ - 'AuthType' => [ - 'description' => 'The authentication type of the origin server. Different origins support different authentication types. The type of origin refers to the SourceType parameter in this operation. If the type of origin is OSS or S3, you must specify the authentication type of the origin. Valid values:'."\n" - ."\n" - .'* **public**: public read. Select this value when the origin type is OSS or S3 and the origin access is public read.'."\n" - .'* **private**: private read. Select this value when the origin type is S3 and the origin access is private read.'."\n" - .'* **private_same_account**: private read under the same account. Select this value when the origin type is OSS, the origins belong to the same Alibaba Cloud account, and the origins have private read access.'."\n" - .'* **private_cross_account**: private read cross accounts. Select this value when the origin type is OSS, the origins belong to different Alibaba Cloud accounts, and the origins have private read access.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'private', - 'title' => '', - ], - 'AccessKey' => [ - 'description' => 'The access key of the account to which the origin server belongs. This parameter is required when the SourceType is OSS, and AuthType is private_cross_account, or when the SourceType is S3 and AuthType is private.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'u0Nkg5gBK*******QF5wvKMM504JUHt', - 'title' => '', - ], - 'SecretKey' => [ - 'description' => 'The secret access key of the account to which the origin server belongs. This parameter is required when the SourceType is OSS, and AuthType is private_same_account, or when the SourceType is S3 and AuthType is private.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'VIxuvJSA2S03f******kp208dy5w7', - 'title' => '', - ], - 'Version' => [ - 'description' => 'The version of the signature algorithm. This parameter is required when the origin type is S3 and AuthType is private. The following two types are supported:'."\n" - ."\n" - .'* **v2**'."\n" - .'* **v4**'."\n" - ."\n" - .'If you leave this parameter empty, the default value v4 is used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'v4', - 'title' => '', - ], - 'Region' => [ - 'description' => 'The region of the origin. If the origin type is S3, you must specify this value. You can get the region information from the official website of S3.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'us-east-1', - 'title' => '', - ], + 'AuthType' => ['description' => 'The origin authentication type. Different origin types support different authentication types. The origin type refers to the SourceType parameter in this API. When the origin type is OSS or S3, you need to specify the origin authentication type. Valid values:'."\n" + .'- **public**: Public read. Select this value when the origin type is OSS or S3 and the origin has public read access.'."\n" + .'- **private**: Private read. Select this value when the origin type is S3 and the origin has private read access.'."\n" + .'- **private_same_account**: Private same-account read. Select this value when the origin type is OSS, the origin is under the same Alibaba Cloud account, and the origin has private read access.'."\n" + .'- **private_cross_account**: Private cross-account read. Select this value when the origin type is OSS, the origin is not under the same Alibaba Cloud account, and the origin has private read access.', 'type' => 'string', 'required' => false, 'example' => 'private', 'title' => ''], + 'AccessKey' => ['description' => 'The AccessKey of the account that owns the origin. This value is required when the origin type is OSS and the authentication type is private cross-account read, or when the origin type is S3 and the authentication type is private read.', 'type' => 'string', 'required' => false, 'example' => 'u0Nkg5gBK*******QF5wvKMM504JUHt', 'title' => ''], + 'SecretKey' => ['description' => 'The SecretKey of the account that owns the origin. This value is required when the origin type is OSS and the authentication type is private cross-account read, or when the origin type is S3 and the authentication type is private read.', 'type' => 'string', 'required' => false, 'example' => 'VIxuvJSA2S03f******kp208dy5w7', 'title' => ''], + 'Version' => ['description' => 'The signature algorithm version. This is required when the origin type is S3 and the authentication type is private read. The following two versions are supported:'."\n" + .'- **v2**'."\n" + .'- **v4**'."\n" + ."\n" + .'If not specified, the default value is v4.', 'type' => 'string', 'required' => false, 'example' => 'v4', 'title' => ''], + 'Region' => ['description' => 'The region where the origin is located. This value is required when the origin type is S3. The region information can be obtained from the official S3 website.', 'type' => 'string', 'required' => false, 'example' => 'us-east-1', 'title' => ''], ], 'required' => false, 'title' => '', @@ -15244,14 +7716,14 @@ 'name' => 'HostPolicy', 'in' => 'query', 'schema' => [ - 'description' => 'The origin host policy. This policy takes effect when the record type is CNAME. You can set the policy in two modes:'."\n" + 'description' => 'The origin host policy. This takes effect when the record type is CNAME. It specifies the host policy for back-to-origin requests. Two modes are available:'."\n" ."\n" - .'* follow_hostname: Follow the host record.'."\n" - .'* follow_origin_domain: match the origin\'s domain name.'."\n", + .'- **follow_hostname**: Follow the request host.'."\n" + .'- **follow_origin_domain**: Follow the origin domain.', 'type' => 'string', + 'enum' => [], 'required' => false, 'example' => 'follow_origin_domain', - 'enum' => [], 'title' => '', ], ], @@ -15261,19 +7733,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', - 'title' => '', - ], - 'RecordId' => [ - 'description' => 'The record ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567890123', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', 'title' => ''], + 'RecordId' => ['description' => 'The ID of the created record.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''], ], 'description' => '', 'title' => '', @@ -15283,509 +7744,117 @@ ], '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' => 'The record name you entered does not meet the specifications. Please adjust the record name according to the product documentation.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter.RecordData', - 'errorMessage' => 'Invalid record content. Adjust your configurations based on the API documentation.', - 'description' => 'Invalid record content. Adjust your configurations based on the API documentation.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'QuotaExceed.RecordCount', - 'errorMessage' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.', - 'description' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.', - ], - [ - 'errorCode' => 'Record.Conflict', - 'errorMessage' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', - 'description' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', - ], - [ - 'errorCode' => 'Site.ServiceBusy', - 'errorMessage' => 'This website is being configured. Try again later.', - 'description' => 'This website is being configured. Try again later.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'QuotaExceed.WildCardRecord', - 'errorMessage' => 'The maximum number of wildcard records has been reached. Delete some and try again.', - 'description' => 'The maximum number of wildcard records has been reached. Delete some and try again.', - ], - [ - 'errorCode' => 'Record.NoResource', - 'errorMessage' => 'Failed to allocate resources for the record. Please submit a ticket for processing.', - 'description' => 'Failed to allocate resources for the record. Please submit a work order for processing.', - ], - [ - 'errorCode' => 'InvalidParameter.InvalidBiz', - 'errorMessage' => 'The incoming parameter value of the business type is empty or incorrect.', - 'description' => 'The incoming parameter value of the business type is empty or incorrect.', - ], - [ - 'errorCode' => 'Record.RecordValueContainSourceInBlacklist', - 'errorMessage' => 'The record value contains the blacklist address, and the details can be submitted for work order consultation.', - 'description' => 'The record value contains the blacklist address, and the details can be submitted for work order consultation.', - ], - [ - 'errorCode' => 'InvalidParameter.InvalidRecordNameSuffix', - 'errorMessage' => 'If you add other records, the suffix of the host record must be the same as the site name.', - 'description' => 'If you add another record, the suffix of the host record must be the same as the site name. Please adjust and try again.', - ], - [ - 'errorCode' => 'InvalidParameter.RecordNameExceedLimit', - 'errorMessage' => 'The length of the record name exceeds the maximum limit.', - 'description' => 'The record name cannot exceed 200 characters.', - ], - [ - 'errorCode' => 'InvalidParameter.InvalidHostPolicy', - 'errorMessage' => 'The host parameter in the origin fetch request is invalid.', - 'description' => 'The host parameter in the origin fetch request is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.CnameSiteRecordUnsupport', - 'errorMessage' => 'The current record type is not supported for a website connected by CNAME setup.', - 'description' => 'You can only add A/AAAA and CNAME records to a website connected by CNAME setup.', - ], - [ - 'errorCode' => 'InvalidParameter.RecordCommentExceedLimit', - 'errorMessage' => 'The number of incoming record comment exceeds the maximum limit.', - 'description' => 'The record comment information is greater than 50 characters.', - ], - [ - 'errorCode' => 'Record.AorAAAARecordValueContainInvalidIP', - 'errorMessage' => 'The A/AAAA record value contains the invalid IP.', - 'description' => 'When creating or editing an A/AAAA record, the record value contains an invalid IP.', - ], - [ - 'errorCode' => 'Record.AorAAAARecordValueIPExceedLimit', - 'errorMessage' => 'The number of IP addresses exceeds the limit for the A/AAAA record.', - 'description' => 'When creating or editing A/AAAA records, the number of IP addresses exceeds the limit. A host record only supports 8 IPv4 and 4 IPv6 IP addresses. Please adjust and try again.', - ], - [ - 'errorCode' => 'Record.CAARecordFlagExceedLimit', - 'errorMessage' => 'The value of the flag parameter for a CAA record is out of range.', - 'description' => 'The value of the flag parameter for a CAA record is out of range while creating or editing DNS record information.', - ], - [ - 'errorCode' => 'Record.CAARecordTagExceedLimit', - 'errorMessage' => 'The CAA record tag has illegal characters other than issue, issuewild, and iodef.', - 'description' => 'When creating or editing CAA records, illegal characters other than issue, issuewild, and iodef are passed in the tag value.', - ], - [ - 'errorCode' => 'Record.CERTRecordAlgorithmExceedLimit', - 'errorMessage' => 'The value of the algorithm parameter for the CERT record is out of range.', - 'description' => 'The value of the algorithm parameter for the CERT record is out of range while creating or editing DNS record information.', - ], - [ - 'errorCode' => 'Record.CERTRecordKeyTagExceedLimit', - 'errorMessage' => 'The value of the keyTag parameter for a CERT record is out of range.', - 'description' => 'The value of the keyTag parameter for a CERT record is out of range when creating or editing DNS record information.', - ], - [ - 'errorCode' => 'Record.CERTRecordTypeExceedLimit', - 'errorMessage' => 'The CERT record type is out of range.', - 'description' => 'The CERT record type parameter was out of range when creating or editing DNS record information.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'Record.CNameRecordValueCannotEqualExistedPoolSource', - 'errorMessage' => 'The CNAME record cannot be the origin of the added source address pool. Check and try again.', - 'description' => 'The CNAME record cannot be the origin of the added source address pool. Check and try again.', - ], - [ - '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' => 'The CNAME record cannot be the origin of an added record. Check the record values of other records and try again.', - ], - [ - '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' => 'The record value of a CNAME record cannot be exactly the same as the name of another existing Layer 4 proxy record.', - ], - [ - 'errorCode' => 'Record.CNameRecordValueCannotEqualOtherExistedRecord', - 'errorMessage' => 'The record value of a CNAME record cannot be the same as the name of another existing CNAME record.', - 'description' => 'The record value of a CNAME record cannot be the same as the name of another existing CNAME record.', - ], - [ - 'errorCode' => 'Record.CNameRecordValueCannotEqualHostRecord', - 'errorMessage' => 'The record value of the CNAME record cannot be exactly the same as the host record.', - 'description' => 'The record value of the CNAME record cannot be exactly the same as the host record. Please adjust and try again.', - ], - [ - 'errorCode' => 'Record.CNameRecordValueExceedLimit', - 'errorMessage' => 'The CNAME record value cannot exceed 253 characters, please delete and try again.', - 'description' => 'The record value cannot exceed 253 characters, please delete and try again.', - ], - [ - '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' => '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.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'Record.EmptyRecordValue', - 'errorMessage' => 'The record value is empty, please fill it in correctly and try again.', - 'description' => 'The record value is empty, please fill it in correctly and try again.', - ], - [ - 'errorCode' => 'Record.InvalidCertEncodeWithCERTRecord', - 'errorMessage' => 'The certificate value of the CERT record is not base64-encoded.', - 'description' => 'When you create or edit CERT record information, the certificate value of the CERT record is not base64-encoded.', - ], - [ - 'errorCode' => 'Record.InvalidFingerprintWithSSHFPRecord', - 'errorMessage' => 'The SSHFP record fingerprint value is not hexadecimal encoded.', - 'description' => 'When creating or editing SSHFP record information, the fingerprint value is not hexadecimal encoded.', - ], - [ - 'errorCode' => 'Record.InvalidIssueDataWithCAARecordTag', - 'errorMessage' => 'The tag of a CAA record can only be a semicolon or a valid domain name separated by semicolons.', - 'description' => 'When creating or editing CAA record information, the tag tag of a CAA record can only be a semicolon or a valid domain name separated by semicolons.', - ], - [ - 'errorCode' => 'Record.InvalidMailAddressWithCAARecordTag', - 'errorMessage' => 'The CAA record tag is prefixed with mailto:, it must be followed by a legal email address.', - 'description' => 'When creating or editing CAA record information, when Tag is iodef and Value is prefixed with mailto:, it must be followed by a legal email address.', - ], - [ - 'errorCode' => 'Record.InvalidSmimeaEncodeWithSMIMEARecord', - 'errorMessage' => 'The certificate value of the SMIMEA record is not base64-encoded.', - 'description' => 'When creating or editing SMIMEA record information, the certificate value of the SMIMEA record is not base64-encoded.', - ], - [ - 'errorCode' => 'Record.InvalidTslaEncodeWithTSLARecord', - 'errorMessage' => 'The certificate value passed in is not hexadecimal encoded with TSLA record.', - 'description' => 'When creating or editing TLSA record information, the certificate value passed in is not hexadecimal encoded.', - ], - [ - 'errorCode' => 'Record.InvalidURLWithURIRecord', - 'errorMessage' => 'The URI record value must be a valid URL address.', - 'description' => 'When creating or editing URI record information, the record value must be a valid URL address.', - ], - [ - 'errorCode' => 'Record.NoRecordNameConflictWithNSRecord', - 'errorMessage' => 'No record name can conflict with an NS record name.', - 'description' => 'No record name can conflict with an NS record name.', - ], - [ - 'errorCode' => 'Record.NSRecordCannotEqualSiteName', - 'errorMessage' => 'An NS record with the exact same name as the site name is not allowed.', - 'description' => 'Adding an NS record with the exact same name as the site name is not allowed.', - ], - [ - 'errorCode' => 'Record.OSSSourceInvalidAuthType', - 'errorMessage' => 'The recorded OSS origin station authentication type is not supported.', - 'description' => 'The recorded OSS origin station authentication type is not supported.', - ], - [ - 'errorCode' => 'Record.ParseJSONRecordValueFailed', - 'errorMessage' => 'The JSON data format of the record data is incorrect. Please adjust and try again.', - 'description' => 'The JSON data format of the record data is incorrect. Please adjust and try again.', - ], - [ - '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' => 'If the source station type of the record is source address pool, the input source address pool does not exist.', - ], - [ - 'errorCode' => 'Record.RecordNameConflictForSpecifiedRecordType', - 'errorMessage' => 'The A/AAAA and CNAME records cannot have the same name.', - 'description' => 'The A/AAAA and CNAME records cannot have the same name.', - ], - [ - 'errorCode' => 'Record.RecordNameConflictWithIPAName', - 'errorMessage' => 'The record name cannot have the same name as the Layer 4 proxy record.', - 'description' => 'When you create or edit DNS record information, the record name cannot have the same name as the Layer 4 proxy record.', - ], - [ - 'errorCode' => 'Record.RecordNameConflictWithLBName', - 'errorMessage' => 'The record name cannot be the same as the Server Load Balancer record name.', - 'description' => 'When creating or editing DNS record information, the record name cannot be the same as the Server Load Balancer record name.', - ], - [ - 'errorCode' => 'Record.RecordNameConflictWithNSRecord', - 'errorMessage' => 'The NS record name cannot be the same as any other type of record name.', - 'description' => 'When creating or editing DNS record information, the NS record name cannot be the same as any other type of record name.', - ], - [ - 'errorCode' => 'Record.RecordNameConflictWithPoolName', - 'errorMessage' => 'The record name cannot be the same as the source address pool record name.', - 'description' => 'When creating or editing DNS record information, the record name cannot be the same as the source address pool record name.', - ], - [ - 'errorCode' => 'Record.RecordNameInBlacklist', - 'errorMessage' => 'The record name is in blacklist.', - 'description' => 'The record name is in the blacklist and cannot be added.', - ], - [ - 'errorCode' => 'Record.S3SourceInvalidAuthRegion', - 'errorMessage' => 'The recorded S3 origin belongs to a region that is not in the supported range.', - 'description' => 'The recorded S3 origin belongs to a region that is not in the supported range.', - ], - [ - 'errorCode' => 'Record.S3SourceInvalidAuthType', - 'errorMessage' => 'The recorded S3 origin authentication type is not supported.', - 'description' => 'The recorded S3 origin authentication type is not supported.', - ], - [ - 'errorCode' => 'Record.S3SourceInvalidAuthVersion', - 'errorMessage' => 'The version of the authentication signature algorithm of the S3 origin is not supported.', - 'description' => 'The version of the authentication signature algorithm of the S3 origin is not supported.', - ], - [ - 'errorCode' => 'Record.SourceAccessKeyExceedLimit', - 'errorMessage' => 'The character length of the AccessKey parameter value for the record source station is out of range.', - 'description' => 'The character length of the AccessKey parameter value for the record source station is out of range.', - ], - [ - 'errorCode' => 'Record.SourceEmptyAK', - 'errorMessage' => 'The AccessKey of the account to which the origin site belongs is empty.', - 'description' => 'The AccessKey of the account to which the origin site belongs is empty.', - ], - [ - 'errorCode' => 'Record.SourceEmptyAuthConf', - 'errorMessage' => 'The authentication information of the origin station is empty.', - 'description' => 'The recorded authentication information of the origin station is empty.', - ], - [ - 'errorCode' => 'Record.SourceEmptySecretKey', - 'errorMessage' => 'The SecretKey of the account to which the recorded origin site belongs is empty.', - 'description' => 'The SecretKey of the account to which the recorded origin site belongs is empty.', - ], - [ - 'errorCode' => 'Record.SourceSecretKeyExceedLimit', - 'errorMessage' => 'The character length of the SecretKey parameter value for the record source station is out of range.', - 'description' => 'The character length of the SecretKey parameter value for the record source station is out of range.', - ], - [ - '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 host record name is not valid. The SRV host record name must begin with an underscore (-), followed by a lowercase letter (a-z), number (0-9), hyphen (-), followed by any character, followed by an underscore (-) and a lowercase letter, number, or hyphen.', - ], - [ - 'errorCode' => 'Record.SRVRecordPortExceedLimit', - 'errorMessage' => 'The SRV record port is out of range.', - 'description' => 'When creating or editing DNS record information, the SRV record port filled in is out of range.', - ], - [ - 'errorCode' => 'Record.SSHFPRecordAlgorithmExceedLimit', - 'errorMessage' => 'The algorithm parameter value for the SSHFP record is out of range.', - 'description' => 'The algorithm parameter value for the SSHFP record is out of range while creating or editing DNS record information.', - ], - [ - 'errorCode' => 'Record.TTLExceedLimit', - 'errorMessage' => 'The TTL parameter value for a record is out of range.', - 'description' => 'The TTL parameter value for a record is out of range while creating or editing DNS record information.', - ], - [ - 'errorCode' => 'Record.TXTRecordValueExceedLimit', - 'errorMessage' => 'The TXT record value cannot exceed 450 characters.', - 'description' => 'When you create or edit DNS record information, the TXT record value cannot exceed 450 characters.', - ], - [ - 'errorCode' => 'Record.TypeExceedLimitWithSSHFPRecord', - 'errorMessage' => 'The SSHFP record Type parameter value is out of range.', - 'description' => 'The SSHFP record Type parameter value is out of range while creating or editing DNS record information.', - ], - [ - 'errorCode' => 'Record.UnmatchedRecordNameContainDoubleConsecutiveDot', - 'errorMessage' => 'Illegal host record name. The host record cannot contain consecutive dot.', - 'description' => 'Illegal host record name. The host record cannot contain consecutive dot.', - ], - [ - 'errorCode' => 'Record.UnmatchedRecordNameForbidStarSev', - 'errorMessage' => 'Illegal host record name, SRV record name disallowed asterisk.', - 'description' => 'Illegal host record name, SRV record name disallowed asterisk.', - ], - [ - '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' => 'Illegal host record name. The \'@\' symbol can only appear at the top of the host record and can only be followed. Symbol, other strings are not allowed.', - ], - [ - 'errorCode' => 'Record.UnmatchedRecordNameInvalidNamePrefixSuffix', - 'errorMessage' => 'Illegal host record name. Host record values cannot start or end with a dot, a hyphens.', - 'description' => 'Illegal host record name. Host record values cannot start or end with a dot, a hyphens.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'Record.UnmatchedRecordNameSeperateStringTooLarge', - 'errorMessage' => 'Illegal host record name. The number of characters in each segment separated by dot cannot exceed 63.', - 'description' => 'Illegal host record name. The number of characters in each segment separated by \'.\' cannot exceed 63.', - ], - [ - 'errorCode' => 'Record.UnsupportedSourceType', - 'errorMessage' => 'The recorded source station type is not in the supported range.', - 'description' => 'The recorded source station type is not in the supported range.', - ], - [ - 'errorCode' => 'Record.UnsupportedType', - 'errorMessage' => 'The record type parameter is unsupported.', - 'description' => 'The record type parameter is incorrect. Please check the record type parameter.', - ], - [ - 'errorCode' => 'Record.ValidProxiedForSpecifedRecordType', - 'errorMessage' => 'Only A/AAAA and CNAME types support proxy acceleration.', - 'description' => 'When creating or editing a record, proxy acceleration is enabled in the proxy state. Only A/AAAA and CNAME types support proxy acceleration.', - ], - [ - 'errorCode' => 'Record.RecordUsageExceedLimit', - 'errorMessage' => 'The usage parameter value filled in is out of range.', - 'description' => 'When creating or editing DNS record information, the usage parameter value filled in is out of range.', - ], - [ - 'errorCode' => 'Record.RecordSelectorExceedLimit', - 'errorMessage' => 'The selector parameter value filled in is out of range.', - 'description' => 'While creating or editing DNS record information, the selector parameter value filled in is out of range.', - ], - [ - 'errorCode' => 'Record.RecordMatchingTypeExceedLimit', - 'errorMessage' => 'The matchingType parameter value filled in is out of range.', - 'description' => 'While creating or editing DNS record information, the matchingType parameter value filled in is out of range.', - ], - [ - 'errorCode' => 'Record.RecordPriorityExceedLimit', - 'errorMessage' => 'The record priority parameter value filled in is out of range.', - 'description' => 'When creating or editing DNS record information, the record priority parameter value filled in is out of range.', - ], - [ - 'errorCode' => 'Record.RecordWeightExceedLimit', - 'errorMessage' => 'The record weight parameter value filled in is out of range.', - 'description' => 'When creating or editing DNS record information, the record weight parameter value filled in is out of range.', - ], - [ - 'errorCode' => 'Record.RecordNameConflictWithSameRecordType', - 'errorMessage' => 'Record conflicts with an existing host record that has the same name and value.', - 'description' => 'Record conflicts with an existing host record that has the same name and value.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'InvalidParameter.InvalidDSRecordName', - 'errorMessage' => 'Please add/import an NS record with the same name before adding this DS record.', - 'description' => 'Please add/import an NS record with the same name before adding this DS record', - ], - [ - 'errorCode' => 'InvalidParameter.CnameSiteRecordNoProxied', - 'errorMessage' => 'A non-proxied record was added for a website using a CNAME setup.', - 'description' => 'A non-proxied record was added for a website using a CNAME setup.', - ], - [ - 'errorCode' => 'Record.InvalidIodefDataWithCAARecordTag', - 'errorMessage' => 'The CAA record Tag value cannot start with mailto: or http:// or https.', - 'description' => 'When creating or editing CAA record information, the Tag value cannot start with mailto: http:// or 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 records cannot add all and asterisk prefixed records at the same time.', - ], - [ - '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' => 'The host record value cannot exist separately in various symbols, and can be added with any lowercase letters or numbers.'."\n", - ], - [ - 'errorCode' => 'SameNameRecordExceedLimit', - 'errorMessage' => 'The number of records with the same name exceeds the upper limit.', - 'description' => 'The number of records with the same name exceeds the upper limit.', - ], - [ - 'errorCode' => 'InvalidParameter.PrivateIpAsSourceUnsupported', - 'errorMessage' => 'The provided source is an invalid private IP address. Please verify and resubmit.', - 'description' => 'The provided source is an invalid private IP address. Please verify and resubmit.', - ], - [ - 'errorCode' => 'InvalidParameter.SourceIpInBlacklist', - 'errorMessage' => 'The provided source is an invalid private IP address. Please verify and resubmit.', - 'description' => 'The provided source is an invalid private IP address. Please verify and resubmit.', - ], - [ - 'errorCode' => 'Record.InvalidHTTPURLValueWithCAARecordTag', - 'errorMessage' => 'The CAA record is prefixed with http:// or https://, it must be followed by a valid URL.', - 'description' => 'When you create or edit a CAA record, if the Tag is `iodef` and the Value starts with `http://` or `https://`, it must be followed by a valid URL.', - ], - [ - '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' => 'Illegal host record character. Only lowercase a-z, uppercase A- Z, digits 0-9, \'-\', \'_\', \'.\', \'*\', and \'@\' are supported as valid characters in host records \',\' @ \'.'."\n", - ], - ], - ], - 'title' => 'CreateRecord', - 'requestParamsDescription' => 'The Data field of a record contains the DNS information for the record. The format of this field varies based on the record type. For more information, see [References](https://www.alibabacloud.com/help/doc-detail/2708761.html) .'."\n", - 'changeSet' => [ - [ - 'createdAt' => '2025-03-28T01:22:08.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2025-02-18T05:59:13.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-11-05T03:27:37.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-10-10T12:01:10.000Z', - 'description' => 'Error codes changed, Request parameters changed', - ], - [ - 'createdAt' => '2024-09-24T08:28:18.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-23T02:21:51.000Z', - 'description' => 'Error codes changed, Request parameters changed', + ['errorCode' => 'InvalidParameter.InvalidRecordName', 'errorMessage' => 'The record name you entered does not meet the specifications. Change the record name according to the product documentation.', 'description' => 'The record name you entered does not meet the specifications. Please adjust the record name according to the product documentation.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.RecordData', 'errorMessage' => 'Invalid record content. Adjust your configurations based on the API documentation.', 'description' => 'Invalid record content. Adjust your configurations based on the API documentation.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'QuotaExceed.RecordCount', 'errorMessage' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.', 'description' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.'], + ['errorCode' => 'Record.Conflict', 'errorMessage' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', 'description' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.'], + ['errorCode' => 'Site.ServiceBusy', 'errorMessage' => 'This website is being configured. Try again later.', 'description' => 'This website is being configured. Try again later.'], + ['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' => '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.'], + ['errorCode' => 'QuotaExceed.WildCardRecord', 'errorMessage' => 'The maximum number of wildcard records has been reached. Delete some and try again.', 'description' => 'The maximum number of wildcard records has been reached. Delete some and try again.'], + ['errorCode' => 'Record.NoResource', 'errorMessage' => 'Failed to allocate resources for the record. Please submit a ticket for processing.', 'description' => 'Failed to allocate resources for the record. Please submit a work order for processing.'], + ['errorCode' => 'InvalidParameter.InvalidBiz', 'errorMessage' => 'The incoming parameter value of the business type is empty or incorrect.', 'description' => 'The incoming parameter value of the business type is empty or incorrect.'], + ['errorCode' => 'Record.RecordValueContainSourceInBlacklist', 'errorMessage' => 'The record value contains the blacklist address, and the details can be submitted for work order consultation.', 'description' => 'The record value contains the blacklist address, and the details can be submitted for work order consultation.'], + ['errorCode' => 'InvalidParameter.InvalidRecordNameSuffix', 'errorMessage' => 'If you add other records, the suffix of the host record must be the same as the site name.', 'description' => 'If you add another record, the suffix of the host record must be the same as the site name. Please adjust and try again.'], + ['errorCode' => 'InvalidParameter.RecordNameExceedLimit', 'errorMessage' => 'The length of the record name exceeds the maximum limit.', 'description' => 'The record name cannot exceed 200 characters.'], + ['errorCode' => 'InvalidParameter.InvalidHostPolicy', 'errorMessage' => 'The host parameter in the origin fetch request is invalid.', 'description' => 'The host parameter in the origin fetch request is invalid.'], + ['errorCode' => 'InvalidParameter.CnameSiteRecordUnsupport', 'errorMessage' => 'The current record type is not supported for a website connected by CNAME setup.', 'description' => 'You can only add A/AAAA and CNAME records to a website connected by CNAME setup.'], + ['errorCode' => 'InvalidParameter.RecordCommentExceedLimit', 'errorMessage' => 'The number of incoming record comment exceeds the maximum limit.', 'description' => 'The record comment information is greater than 50 characters.'], + ['errorCode' => 'Record.AorAAAARecordValueContainInvalidIP', 'errorMessage' => 'The A/AAAA record value contains the invalid IP.', 'description' => 'When creating or editing an A/AAAA record, the record value contains an invalid IP.'], + ['errorCode' => 'Record.AorAAAARecordValueIPExceedLimit', 'errorMessage' => 'The number of IP addresses exceeds the limit for the A/AAAA record.', 'description' => 'When creating or editing A/AAAA records, the number of IP addresses exceeds the limit. A host record only supports 8 IPv4 and 4 IPv6 IP addresses. Please adjust and try again.'], + ['errorCode' => 'Record.CAARecordFlagExceedLimit', 'errorMessage' => 'The value of the flag parameter for a CAA record is out of range.', 'description' => 'The value of the flag parameter for a CAA record is out of range while creating or editing DNS record information.'], + ['errorCode' => 'Record.CAARecordTagExceedLimit', 'errorMessage' => 'The CAA record tag has illegal characters other than issue, issuewild, and iodef.', 'description' => 'When creating or editing CAA records, illegal characters other than issue, issuewild, and iodef are passed in the tag value.'], + ['errorCode' => 'Record.CERTRecordAlgorithmExceedLimit', 'errorMessage' => 'The value of the algorithm parameter for the CERT record is out of range.', 'description' => 'The value of the algorithm parameter for the CERT record is out of range while creating or editing DNS record information.'], + ['errorCode' => 'Record.CERTRecordKeyTagExceedLimit', 'errorMessage' => 'The value of the keyTag parameter for a CERT record is out of range.', 'description' => 'The value of the keyTag parameter for a CERT record is out of range when creating or editing DNS record information.'], + ['errorCode' => 'Record.CERTRecordTypeExceedLimit', 'errorMessage' => 'The CERT record type is out of range.', 'description' => 'The CERT record type parameter was out of range when creating or editing DNS record information.'], + ['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' => '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.'], + ['errorCode' => 'Record.CNameRecordValueCannotEqualExistedPoolSource', 'errorMessage' => 'The CNAME record cannot be the origin of the added source address pool. Check and try again.', 'description' => 'The CNAME record cannot be the origin of the added source address pool. Check and try again.'], + ['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' => 'The CNAME record cannot be the origin of an added record. Check the record values of other records and try again.'], + ['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' => 'The record value of a CNAME record cannot be exactly the same as the name of another existing Layer 4 proxy record.'], + ['errorCode' => 'Record.CNameRecordValueCannotEqualOtherExistedRecord', 'errorMessage' => 'The record value of a CNAME record cannot be the same as the name of another existing CNAME record.', 'description' => 'The record value of a CNAME record cannot be the same as the name of another existing CNAME record.'], + ['errorCode' => 'Record.CNameRecordValueCannotEqualHostRecord', 'errorMessage' => 'The record value of the CNAME record cannot be exactly the same as the host record.', 'description' => 'The record value of the CNAME record cannot be exactly the same as the host record. Please adjust and try again.'], + ['errorCode' => 'Record.CNameRecordValueExceedLimit', 'errorMessage' => 'The CNAME record value cannot exceed 253 characters, please delete and try again.', 'description' => 'The record value cannot exceed 253 characters, please delete and try again.'], + ['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' => '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.'], + ['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' => '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.'], + ['errorCode' => 'Record.EmptyRecordValue', 'errorMessage' => 'The record value is empty, please fill it in correctly and try again.', 'description' => 'The record value is empty, please fill it in correctly and try again.'], + ['errorCode' => 'Record.InvalidCertEncodeWithCERTRecord', 'errorMessage' => 'The certificate value of the CERT record is not base64-encoded.', 'description' => 'When you create or edit CERT record information, the certificate value of the CERT record is not base64-encoded.'], + ['errorCode' => 'Record.InvalidFingerprintWithSSHFPRecord', 'errorMessage' => 'The SSHFP record fingerprint value is not hexadecimal encoded.', 'description' => 'When creating or editing SSHFP record information, the fingerprint value is not hexadecimal encoded.'], + ['errorCode' => 'Record.InvalidIssueDataWithCAARecordTag', 'errorMessage' => 'The tag of a CAA record can only be a semicolon or a valid domain name separated by semicolons.', 'description' => 'When creating or editing CAA record information, the tag tag of a CAA record can only be a semicolon or a valid domain name separated by semicolons.'], + ['errorCode' => 'Record.InvalidMailAddressWithCAARecordTag', 'errorMessage' => 'The CAA record tag is prefixed with mailto:, it must be followed by a legal email address.', 'description' => 'When creating or editing CAA record information, when Tag is iodef and Value is prefixed with mailto:, it must be followed by a legal email address.'], + ['errorCode' => 'Record.InvalidSmimeaEncodeWithSMIMEARecord', 'errorMessage' => 'The certificate value of the SMIMEA record is not base64-encoded.', 'description' => 'When creating or editing SMIMEA record information, the certificate value of the SMIMEA record is not base64-encoded.'], + ['errorCode' => 'Record.InvalidTslaEncodeWithTSLARecord', 'errorMessage' => 'The certificate value passed in is not hexadecimal encoded with TSLA record.', 'description' => 'When creating or editing TLSA record information, the certificate value passed in is not hexadecimal encoded.'], + ['errorCode' => 'Record.InvalidURLWithURIRecord', 'errorMessage' => 'The URI record value must be a valid URL address.', 'description' => 'When creating or editing URI record information, the record value must be a valid URL address.'], + ['errorCode' => 'Record.NoRecordNameConflictWithNSRecord', 'errorMessage' => 'No record name can conflict with an NS record name.', 'description' => 'No record name can conflict with an NS record name.'], + ['errorCode' => 'Record.NSRecordCannotEqualSiteName', 'errorMessage' => 'An NS record with the exact same name as the site name is not allowed.', 'description' => 'Adding an NS record with the exact same name as the site name is not allowed.'], + ['errorCode' => 'Record.OSSSourceInvalidAuthType', 'errorMessage' => 'The recorded OSS origin station authentication type is not supported.', 'description' => 'The recorded OSS origin station authentication type is not supported.'], + ['errorCode' => 'Record.ParseJSONRecordValueFailed', 'errorMessage' => 'The JSON data format of the record data is incorrect. Please adjust and try again.', 'description' => 'The JSON data format of the record data is incorrect. Please adjust and try again.'], + ['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' => 'If the source station type of the record is source address pool, the input source address pool does not exist.'], + ['errorCode' => 'Record.RecordNameConflictForSpecifiedRecordType', 'errorMessage' => 'The A/AAAA and CNAME records cannot have the same name.', 'description' => 'The A/AAAA and CNAME records cannot have the same name.'], + ['errorCode' => 'Record.RecordNameConflictWithIPAName', 'errorMessage' => 'The record name cannot have the same name as the Layer 4 proxy record.', 'description' => 'When you create or edit DNS record information, the record name cannot have the same name as the Layer 4 proxy record.'], + ['errorCode' => 'Record.RecordNameConflictWithLBName', 'errorMessage' => 'The record name cannot be the same as the Server Load Balancer record name.', 'description' => 'When creating or editing DNS record information, the record name cannot be the same as the Server Load Balancer record name.'], + ['errorCode' => 'Record.RecordNameConflictWithNSRecord', 'errorMessage' => 'The NS record name cannot be the same as any other type of record name.', 'description' => 'When creating or editing DNS record information, the NS record name cannot be the same as any other type of record name.'], + ['errorCode' => 'Record.RecordNameConflictWithPoolName', 'errorMessage' => 'The record name cannot be the same as the source address pool record name.', 'description' => 'When creating or editing DNS record information, the record name cannot be the same as the source address pool record name.'], + ['errorCode' => 'Record.RecordNameInBlacklist', 'errorMessage' => 'The record name is in blacklist.', 'description' => 'The record name is in the blacklist and cannot be added.'], + ['errorCode' => 'Record.S3SourceInvalidAuthRegion', 'errorMessage' => 'The recorded S3 origin belongs to a region that is not in the supported range.', 'description' => 'The recorded S3 origin belongs to a region that is not in the supported range.'], + ['errorCode' => 'Record.S3SourceInvalidAuthType', 'errorMessage' => 'The recorded S3 origin authentication type is not supported.', 'description' => 'The recorded S3 origin authentication type is not supported.'], + ['errorCode' => 'Record.S3SourceInvalidAuthVersion', 'errorMessage' => 'The version of the authentication signature algorithm of the S3 origin is not supported.', 'description' => 'The version of the authentication signature algorithm of the S3 origin is not supported.'], + ['errorCode' => 'Record.SourceAccessKeyExceedLimit', 'errorMessage' => 'The character length of the AccessKey parameter value for the record source station is out of range.', 'description' => 'The character length of the AccessKey parameter value for the record source station is out of range.'], + ['errorCode' => 'Record.SourceEmptyAK', 'errorMessage' => 'The AccessKey of the account to which the origin site belongs is empty.', 'description' => 'The AccessKey of the account to which the origin site belongs is empty.'], + ['errorCode' => 'Record.SourceEmptyAuthConf', 'errorMessage' => 'The authentication information of the origin station is empty.', 'description' => 'The recorded authentication information of the origin station is empty.'], + ['errorCode' => 'Record.SourceEmptySecretKey', 'errorMessage' => 'The SecretKey of the account to which the recorded origin site belongs is empty.', 'description' => 'The SecretKey of the account to which the recorded origin site belongs is empty.'], + ['errorCode' => 'Record.SourceSecretKeyExceedLimit', 'errorMessage' => 'The character length of the SecretKey parameter value for the record source station is out of range.', 'description' => 'The character length of the SecretKey parameter value for the record source station is out of range.'], + ['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 host record name is not valid. The SRV host record name must begin with an underscore (-), followed by a lowercase letter (a-z), number (0-9), hyphen (-), followed by any character, followed by an underscore (-) and a lowercase letter, number, or hyphen.'], + ['errorCode' => 'Record.SRVRecordPortExceedLimit', 'errorMessage' => 'The SRV record port is out of range.', 'description' => 'When creating or editing DNS record information, the SRV record port filled in is out of range.'], + ['errorCode' => 'Record.SSHFPRecordAlgorithmExceedLimit', 'errorMessage' => 'The algorithm parameter value for the SSHFP record is out of range.', 'description' => 'The algorithm parameter value for the SSHFP record is out of range while creating or editing DNS record information.'], + ['errorCode' => 'Record.TTLExceedLimit', 'errorMessage' => 'The TTL parameter value for a record is out of range.', 'description' => 'The TTL parameter value for a record is out of range while creating or editing DNS record information.'], + ['errorCode' => 'Record.TXTRecordValueExceedLimit', 'errorMessage' => 'The TXT record value cannot exceed 450 characters.', 'description' => 'When you create or edit DNS record information, the TXT record value cannot exceed 450 characters.'], + ['errorCode' => 'Record.TypeExceedLimitWithSSHFPRecord', 'errorMessage' => 'The SSHFP record Type parameter value is out of range.', 'description' => 'The SSHFP record Type parameter value is out of range while creating or editing DNS record information.'], + ['errorCode' => 'Record.UnmatchedRecordNameContainDoubleConsecutiveDot', 'errorMessage' => 'Illegal host record name. The host record cannot contain consecutive dot.', 'description' => 'Illegal host record name. The host record cannot contain consecutive dot.'], + ['errorCode' => 'Record.UnmatchedRecordNameForbidStarSev', 'errorMessage' => 'Illegal host record name, SRV record name disallowed asterisk.', 'description' => 'Illegal host record name, SRV record name disallowed asterisk.'], + ['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' => 'Illegal host record name. The \'@\' symbol can only appear at the top of the host record and can only be followed. Symbol, other strings are not allowed.'], + ['errorCode' => 'Record.UnmatchedRecordNameInvalidNamePrefixSuffix', 'errorMessage' => 'Illegal host record name. Host record values cannot start or end with a dot, a hyphens.', 'description' => 'Illegal host record name. Host record values cannot start or end with a dot, a hyphens.'], + ['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' => '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.'], + ['errorCode' => 'Record.UnmatchedRecordNameSeperateStringTooLarge', 'errorMessage' => 'Illegal host record name. The number of characters in each segment separated by dot cannot exceed 63.', 'description' => 'Illegal host record name. The number of characters in each segment separated by \'.\' cannot exceed 63.'], + ['errorCode' => 'Record.UnsupportedSourceType', 'errorMessage' => 'The recorded source station type is not in the supported range.', 'description' => 'The recorded source station type is not in the supported range.'], + ['errorCode' => 'Record.UnsupportedType', 'errorMessage' => 'The record type parameter is unsupported.', 'description' => 'The record type parameter is incorrect. Please check the record type parameter.'], + ['errorCode' => 'Record.ValidProxiedForSpecifedRecordType', 'errorMessage' => 'Only A/AAAA and CNAME types support proxy acceleration.', 'description' => 'When creating or editing a record, proxy acceleration is enabled in the proxy state. Only A/AAAA and CNAME types support proxy acceleration.'], + ['errorCode' => 'Record.RecordUsageExceedLimit', 'errorMessage' => 'The usage parameter value filled in is out of range.', 'description' => 'When creating or editing DNS record information, the usage parameter value filled in is out of range.'], + ['errorCode' => 'Record.RecordSelectorExceedLimit', 'errorMessage' => 'The selector parameter value filled in is out of range.', 'description' => 'While creating or editing DNS record information, the selector parameter value filled in is out of range.'], + ['errorCode' => 'Record.RecordMatchingTypeExceedLimit', 'errorMessage' => 'The matchingType parameter value filled in is out of range.', 'description' => 'While creating or editing DNS record information, the matchingType parameter value filled in is out of range.'], + ['errorCode' => 'Record.RecordPriorityExceedLimit', 'errorMessage' => 'The record priority parameter value filled in is out of range.', 'description' => 'When creating or editing DNS record information, the record priority parameter value filled in is out of range.'], + ['errorCode' => 'Record.RecordWeightExceedLimit', 'errorMessage' => 'The record weight parameter value filled in is out of range.', 'description' => 'When creating or editing DNS record information, the record weight parameter value filled in is out of range.'], + ['errorCode' => 'Record.RecordNameConflictWithSameRecordType', 'errorMessage' => 'Record conflicts with an existing host record that has the same name and value.', 'description' => 'Record conflicts with an existing host record that has the same name and value.'], + ['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' => '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.'], + ['errorCode' => 'InvalidParameter.InvalidDSRecordName', 'errorMessage' => 'Please add/import an NS record with the same name before adding this DS record.', 'description' => 'Please add/import an NS record with the same name before adding this DS record'], + ['errorCode' => 'InvalidParameter.CnameSiteRecordNoProxied', 'errorMessage' => 'A non-proxied record was added for a website using a CNAME setup.', 'description' => 'A non-proxied record was added for a website using a CNAME setup.'], + ['errorCode' => 'Record.InvalidIodefDataWithCAARecordTag', 'errorMessage' => 'The CAA record Tag value cannot start with mailto: or http:// or https.', 'description' => 'When creating or editing CAA record information, the Tag value cannot start with mailto: http:// or 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 records cannot add all and asterisk prefixed records at the same time.'], + ['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' => 'The host record value cannot exist separately in various symbols, and can be added with any lowercase letters or numbers.'."\n"], + ['errorCode' => 'SameNameRecordExceedLimit', 'errorMessage' => 'The number of records with the same name exceeds the upper limit.', 'description' => 'The number of records with the same name exceeds the upper limit.'], + ['errorCode' => 'InvalidParameter.PrivateIpAsSourceUnsupported', 'errorMessage' => 'The provided source is an invalid private IP address. Please verify and resubmit.', 'description' => 'The provided source is an invalid private IP address. Please verify and resubmit.'], + ['errorCode' => 'InvalidParameter.SourceIpInBlacklist', 'errorMessage' => 'The provided source is an invalid private IP address. Please verify and resubmit.', 'description' => 'The provided source is an invalid private IP address. Please verify and resubmit.'], + ['errorCode' => 'Record.InvalidHTTPURLValueWithCAARecordTag', 'errorMessage' => 'The CAA record is prefixed with http:// or https://, it must be followed by a valid URL.', 'description' => 'When you create or edit a CAA record, if the Tag is `iodef` and the Value starts with `http://` or `https://`, it must be followed by a valid URL.'], + ['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' => 'Illegal host record character. Only lowercase a-z, uppercase A- Z, digits 0-9, \'-\', \'_\', \'.\', \'*\', and \'@\' are supported as valid characters in host records \',\' @ \'.'."\n"], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F61CDR30-E83C-4FDA-BF73-9A94CDD44229\\",\\n \\"RecordId\\": 1234567890123\\n}","type":"json"}]', + 'title' => 'Create DNS Record', + 'requestParamsDescription' => 'The Data section of the record, including the DNS information of the record. Different types of records require different content for this field. For more information, see'."\n" + .'[Documentation](https://help.aliyun.com/document_detail/2708761.html)[Documentation](https://www.alibabacloud.com/help/doc-detail/2708761.html)'."\n" + .'.', + 'changeSet' => [ + ['createdAt' => '2025-03-28T01:22:08.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2025-02-18T05:59:13.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-11-05T03:27:37.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-10-10T12:01:10.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2024-09-24T08:28:18.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-23T02:21:51.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '10', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateRecord', - ], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRecord'], ], ], 'ramActions' => [ @@ -15796,25 +7865,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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', - ], + 'summary' => 'Creates a redirect configuration for a site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -15827,130 +7887,83 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257657', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the version of the site for which the configuration will take effect. The default is version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version on which the configuration takes effect. The default value is version 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. You do not need to set this parameter when adding a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Value range:'."\n" + 'description' => 'The rule switch. You do not need to set this parameter when adding a global configuration. Valid values:'."\n" .'- on: Enabled.'."\n" .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- To match all incoming requests: Set the value to true'."\n" - .'- To match specific requests: Set the value to a custom expression, e.g., (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], + 'schema' => ['description' => 'The rule content, which uses a conditional expression to match user requests. You do not need to set this parameter when adding a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + .'- Match specified requests: Set the value to a custom expression, such as (http.host eq \\"video.example.com\\").', 'type' => 'string', 'required' => false, 'example' => '(http.host eq "video.example.com")', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => 'Redirect type. Value range:'."\n" + 'description' => 'The redirect type. Valid values:'."\n" ."\n" - .'- static: Static mode.'."\n" - .'- dynamic: Dynamic mode.', + .'- static: Static pattern.'."\n" + .'- dynamic: Dynamic pattern.', + 'enumValueTitles' => ['static' => 'Static mode.', 'dynamic' => 'Dynamic pattern.'], 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'static' => 'static', - 'dynamic' => 'dynamic', - ], + 'enum' => ['static', 'dynamic'], 'example' => 'static', - 'enum' => [ - 'static', - 'dynamic', - ], 'title' => '', ], ], [ 'name' => 'TargetUrl', 'in' => 'query', - 'schema' => [ - 'description' => 'Target URL after redirection.', - 'type' => 'string', - 'required' => true, - 'example' => 'http://www.exapmle.com/index.html'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The target URL after redirection.', 'type' => 'string', 'required' => true, 'example' => 'http://www.exapmle.com/index.html'."\n", 'title' => ''], ], [ 'name' => 'StatusCode', 'in' => 'query', 'schema' => [ - 'description' => 'Response status code used by the node to respond to the client with the redirect address. Value range:'."\n" + 'description' => 'The response status code used by the node when responding to the client with the redirect address. Valid values:'."\n" ."\n" .'- 301'."\n" .'- 302'."\n" .'- 303'."\n" .'- 307'."\n" - .'- 308', + .'- 308.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, + 'enum' => ['301', '302', '303', '307', '308'], 'example' => '301', - 'enum' => [ - '301', - '302', - '303', - '307', - '308', - ], 'title' => '', ], ], @@ -15958,53 +7971,33 @@ 'name' => 'ReserveQueryString', 'in' => 'query', 'schema' => [ - 'description' => 'Preserve query string. Value range:'."\n" + 'description' => 'Specifies whether to preserve the query string. Valid values:'."\n" ."\n" .'- on: Enabled.'."\n" .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', 'required' => true, + 'enum' => ['on', 'off'], 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule execution order. Rules with smaller values take precedence. ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Request response result.', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '1FCB0DA6-9B6D-509D-B91C-B9B9F0780D0E', - ], - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '35281609698****', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1FCB0DA6-9B6D-509D-B91C-B9B9F0780D0E'], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '35281609698****', 'title' => ''], ], 'example' => '', ], @@ -16012,193 +8005,69 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'VerifyExpressionError', - 'errorMessage' => 'Dynamic expression is invalid.', - 'description' => 'Dynamic expression is invalid.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['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' => '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.'], + ['errorCode' => 'VerifyExpressionError', 'errorMessage' => 'Dynamic expression is invalid.', 'description' => 'Dynamic expression is invalid.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'Create Redirect Configuration', - 'summary' => 'Add a Redirect Rule', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1FCB0DA6-9B6D-509D-B91C-B9B9F0780D0E\\",\\n \\"ConfigId\\": 0\\n}","type":"json"}]', + 'title' => 'Create redirect configuration', 'changeSet' => [ - [ - 'createdAt' => '2025-04-10T07:02:38.000Z', - 'description' => 'Error codes changed, Request parameters changed', - ], - [ - 'createdAt' => '2025-03-27T02:58:48.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-04-10T07:02:38.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2025-03-27T02:58:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateRedirectRule', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRedirectRule'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateRedirectRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1FCB0DA6-9B6D-509D-B91C-B9B9F0780D0E\\",\\n \\"ConfigId\\": 0\\n}","type":"json"}]', ], 'CreateRewriteUrlRule' => [ - 'summary' => 'Add Rewrite URL Rule', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Create a rewrite URL rule configuration for a site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -16211,73 +8080,43 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257641', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the effective version of the site configuration, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: set the value to true'."\n" - .'- Match specific requests: set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq "video.example.com")'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The rule content, which uses conditional expressions to match user requests. This parameter does not need to be set when adding global configurations. There are two usage scenarios:'."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + .'- Match specified requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\").', 'type' => 'string', 'required' => false, 'example' => '(http.host eq "video.example.com")'."\n", 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. This parameter does not need to be set when adding global configurations.', 'type' => 'string', 'required' => false, 'example' => 'rule_example'."\n", 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Value range:'."\n" - .'- on: enable.'."\n" - .'- off: disable.', + 'description' => 'The rule switch. This parameter does not need to be set when adding global configurations. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], @@ -16286,96 +8125,60 @@ 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ - 'description' => 'URI rewrite type. Value range:'."\n" + 'description' => 'The URI rewrite type. Valid values:'."\n" ."\n" .'- static: static mode.'."\n" .'- dynamic: dynamic mode.', + 'enumValueTitles' => ['static' => 'Static mode', 'dynamic' => 'Dynamic mode'], 'type' => 'string', + 'enum' => [], 'required' => false, - 'enumValueTitles' => [ - 'static' => 'static', - 'dynamic' => 'dynamic', - ], 'example' => 'static', - 'enum' => [], 'title' => '', ], ], [ 'name' => 'Uri', 'in' => 'query', - 'schema' => [ - 'description' => 'The target URI after rewriting.', - 'type' => 'string', - 'required' => false, - 'example' => '/image/example.jpg'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The destination URI after rewriting.', 'type' => 'string', 'required' => false, 'example' => '/image/example.jpg'."\n", 'title' => ''], ], [ 'name' => 'RewriteQueryStringType', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ - 'description' => 'Query string rewrite type. Value range:'."\n" + 'description' => 'The query string rewrite type. Valid values:'."\n" ."\n" .'- static: static mode.'."\n" .'- dynamic: dynamic mode.', + 'enumValueTitles' => ['static' => 'Static mode', 'dynamic' => 'Dynamic mode'], 'type' => 'string', + 'enum' => [], 'required' => false, - 'enumValueTitles' => [ - 'static' => 'static', - 'dynamic' => 'dynamic', - ], 'example' => 'static'."\n", - 'enum' => [], 'title' => '', ], ], [ 'name' => 'QueryString', 'in' => 'query', - 'schema' => [ - 'description' => 'The query string after rewriting.', - 'type' => 'string', - 'required' => false, - 'example' => 'example=123'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The query string after rewriting.', 'type' => 'string', 'required' => false, 'example' => 'example=123'."\n", 'title' => ''], ], [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule execution order. A smaller numeric value indicates higher priority. ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Request response result.', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', - ], - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '39237781679****', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE'], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '39237781679****', 'title' => ''], ], 'example' => '', ], @@ -16383,193 +8186,68 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'VerifyExpressionError', - 'errorMessage' => 'Dynamic expression is invalid.', - 'description' => 'Dynamic expression is invalid.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['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' => '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.'], + ['errorCode' => 'VerifyExpressionError', 'errorMessage' => 'Dynamic expression is invalid.', 'description' => 'Dynamic expression is invalid.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'Add Rewrite URL Configuration', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\",\\n \\"ConfigId\\": 0\\n}","type":"json"}]', + 'title' => 'CreateRewriteUrlRule', 'changeSet' => [ - [ - 'createdAt' => '2025-04-10T07:02:38.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2025-03-27T02:58:48.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-04-10T07:02:38.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2025-03-27T02:58:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateRewriteUrlRule', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRewriteUrlRule'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateRewriteUrlRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\",\\n \\"ConfigId\\": 0\\n}","type":"json"}]', ], 'CreateRoutine' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -16582,64 +8260,34 @@ 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeCode' => '238770', - 'abilityTreeNodes' => [ - 'FEATUREdcdn75UYDO', - ], + 'abilityTreeNodes' => ['FEATUREdcdn75UYDO'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The routine name, which must be unique in the same account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-routine1', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Edge Routine. The name must be unique within the same account.', 'type' => 'string', 'required' => true, 'example' => 'test-routine1', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'formData', - 'schema' => [ - 'description' => 'The routine description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'the description of this routine', - 'title' => '', - ], + 'schema' => ['description' => 'The description of the Edge Routine.', 'type' => 'string', 'required' => false, 'example' => 'the description of this routine', 'title' => ''], ], [ 'name' => 'HasAssets', 'in' => 'formData', - 'schema' => [ - 'description' => 'Indicates whether the package includes Assets files.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether the Edge Routine contains asset files.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', - ], - 'Status' => [ - 'description' => 'Indicates whether the operation is successful.'."\n", - 'type' => 'string', - 'example' => 'OK', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395'], + 'Status' => ['description' => 'The result of the operation. Indicates whether the operation was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'example' => '', ], @@ -16647,78 +8295,27 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'RoutineAlreadyExist', - 'errorMessage' => 'The routine name already exists.', - 'description' => 'The routine name already exists.', - ], - [ - 'errorCode' => 'InternalOperationError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'ParameterNotExist', - 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', - 'description' => 'The specified parameter does not exist. Check your configurations and try again.', - ], - [ - 'errorCode' => 'ServiceNotOpen', - 'errorMessage' => 'You have not activated Edge Routine. Activate the service and try again.', - 'description' => 'You have not activated Edge Routine. Activate the service and try again.', - ], - [ - 'errorCode' => 'RoutineNumberExceedQuotaLimit', - 'errorMessage' => 'The maximum number of configuration items for the feature has been reached. Adjust your configurations and try again.', - 'description' => 'The maximum number of configuration items for the feature has been reached. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'DependedByOthers', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'RoutineUserServiceStatusHalt', - 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', - 'description' => 'Failed to update the configurations because you have overdue payments.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'UserOperationStatusIsLocked', - 'errorMessage' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', - 'description' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', - ], - ], - ], - 'title' => 'Create Edge Routine', - 'summary' => 'Create an Edge Routine.', - 'changeSet' => [ - [ - 'createdAt' => '2024-12-04T05:48:49.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-11-05T06:54:07.000Z', - 'description' => 'Error codes changed', + ['errorCode' => 'RoutineAlreadyExist', 'errorMessage' => 'The routine name already exists.', 'description' => 'The routine name already exists.'], + ['errorCode' => 'InternalOperationError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'ParameterNotExist', 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', 'description' => 'The specified parameter does not exist. Check your configurations and try again.'], + ['errorCode' => 'ServiceNotOpen', 'errorMessage' => 'You have not activated Edge Routine. Activate the service and try again.', 'description' => 'You have not activated Edge Routine. Activate the service and try again.'], + ['errorCode' => 'RoutineNumberExceedQuotaLimit', 'errorMessage' => 'The maximum number of configuration items for the feature has been reached. Adjust your configurations and try again.', 'description' => 'The maximum number of configuration items for the feature has been reached. Adjust your configurations and try again.'], + ['errorCode' => 'DependedByOthers', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'RoutineUserServiceStatusHalt', 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', 'description' => 'Failed to update the configurations because you have overdue payments.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'UserOperationStatusIsLocked', 'errorMessage' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', 'description' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.'], ], ], + 'title' => 'Create an edge routine', + 'summary' => 'Creates an Edge Routine.', + 'changeSet' => [ + ['createdAt' => '2024-12-04T05:48:49.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-05T06:54:07.000Z', 'description' => 'Error codes changed'], + ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '1', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateRoutine', - ], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRoutine'], ], ], 'ramActions' => [ @@ -16729,12 +8326,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -16742,14 +8334,9 @@ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"Status\\": \\"OK\\"\\n}","type":"json"}]', ], 'CreateRoutineCodeDeployment' => [ - 'summary' => 'Release the version of the function code in proportion to the specified environment.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Creates a percentage-based canary deployment for a Routine code version in a specified environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -16762,34 +8349,26 @@ 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeCode' => '238829', - 'abilityTreeNodes' => [ - 'FEATUREdcdn75UYDO', - ], + 'abilityTreeNodes' => ['FEATUREdcdn75UYDO'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The function name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Edge Function Routine.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'Env', 'in' => 'formData', 'schema' => [ - 'description' => 'The name of the environment. Only supports test environment `staging` or production environment `production`.'."\n", + 'description' => 'The environment name. '."\n" + .'Valid values:'."\n" + .'- `staging`: staging environment '."\n" + .'- `production`: production environment', 'type' => 'string', 'required' => true, - 'enum' => [ - 'production', - 'staging', - ], 'example' => 'staging', + 'enum' => ['production', 'staging'], 'title' => '', ], ], @@ -16797,13 +8376,13 @@ 'name' => 'Strategy', 'in' => 'formData', 'schema' => [ - 'description' => 'The deployment policy. Valid value: percentage.'."\n", + 'description' => 'The deployment strategy. '."\n" + .'Valid values:'."\n" + .'- `percentage`: percentage mode', 'type' => 'string', 'required' => true, - 'enum' => [ - 'percentage', - ], 'example' => 'percentage', + 'enum' => ['percentage'], 'title' => '', ], ], @@ -16812,27 +8391,14 @@ 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The configuration list of phased release version numbers. A maximum of two versions are supported, and the sum of the total proportions is equal to 100.'."\n", + 'description' => 'The list of percentage-based canary release version configurations. A maximum of two versions are supported, and the total percentage must equal 100.', 'type' => 'array', 'items' => [ - 'description' => 'Phased release version number.'."\n", + 'description' => 'A single percentage-based canary release version configuration.', 'type' => 'object', 'properties' => [ - 'Percentage' => [ - 'description' => 'The phased release ratio of the code version. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '100', - 'title' => '', - ], - 'CodeVersion' => [ - 'description' => 'The version of the code.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1723599747213377175', - 'title' => '', - ], + 'Percentage' => ['description' => 'The canary release percentage for the code version. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100', 'title' => ''], + 'CodeVersion' => ['description' => 'The code version number.', 'type' => 'string', 'required' => true, 'example' => '1723599747213377175', 'title' => ''], ], 'required' => true, 'title' => '', @@ -16849,48 +8415,22 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', - ], - 'Strategy' => [ - 'description' => 'The phased release policy. The constant string is "percentage".'."\n", - 'type' => 'string', - 'example' => 'percentage', - 'title' => '', - ], - 'DeploymentId' => [ - 'description' => 'The deployment record ID.'."\n", - 'type' => 'string', - 'example' => '234', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395'], + 'Strategy' => ['description' => 'The canary release strategy. Fixed value: percentage.'."\n", 'type' => 'string', 'example' => 'percentage', 'title' => ''], + 'DeploymentId' => ['description' => 'The deployment record ID.'."\n", 'type' => 'string', 'example' => '234', 'title' => ''], 'CodeVersions' => [ - 'description' => 'The configuration list of the phased release version number.'."\n", + 'description' => 'The list of percentage-based canary release code version configurations.', 'type' => 'array', 'items' => [ - 'description' => 'The configuration of the phased release version number.'."\n", + 'description' => 'A single percentage-based canary release code version configuration.', 'type' => 'object', 'properties' => [ - 'Percentage' => [ - 'description' => 'The phased release ratio.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - 'title' => '', - ], - 'CodeVersion' => [ - 'description' => 'The version of the code.'."\n", - 'type' => 'string', - 'example' => '1723599747213377175', - 'title' => '', - ], + 'Percentage' => ['description' => 'The canary release percentage for the code version.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'CodeVersion' => ['description' => 'The code version number.', 'type' => 'string', 'example' => '1723599747213377175', 'title' => ''], ], 'title' => '', 'example' => '', @@ -16905,53 +8445,25 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'RoutineNotExist', - 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', - 'description' => 'The routine name does not exist. Check the routine name and try again.', - ], - [ - 'errorCode' => 'ParameterNotExist', - 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', - 'description' => 'The specified parameter does not exist. Check your configurations and try again.', - ], - [ - 'errorCode' => 'InternalOperationError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'DependedByOthers', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'RoutineUserServiceStatusHalt', - 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', - 'description' => 'Failed to update the configurations because you have overdue payments.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter verification failed. Check your configurations and try again.', - 'description' => 'Parameter verification failed. Check your configurations and try again.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'RoutineNotExist', 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', 'description' => 'The routine name does not exist. Check the routine name and try again.'], + ['errorCode' => 'ParameterNotExist', 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', 'description' => 'The specified parameter does not exist. Check your configurations and try again.'], + ['errorCode' => 'InternalOperationError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'DependedByOthers', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'RoutineUserServiceStatusHalt', 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', 'description' => 'Failed to update the configurations because you have overdue payments.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter verification failed. Check your configurations and try again.', 'description' => 'Parameter verification failed. Check your configurations and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateRoutineCodeDeployment', - 'description' => '## 请求说明'."\n" - .'- 创建Routine代码版本部署时，环境名`Env`仅支持填写测试环境`staging`或生产环境`production`。'."\n" - .'- `CodeVersions`参数最多支持两个版本的灰度发布，并且这些版本的比例总和必须等于100%。'."\n", + 'description' => '## Usage notes'."\n" + .'- When creating a Routine code version deployment, the `Env` parameter only supports `staging` for the staging environment or `production` for the production environment.'."\n" + .'- The `CodeVersions` parameter supports a maximum of two versions for canary release, and the total percentage of these versions must equal 100%.'."\n", 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRoutineCodeDeployment'], + ], ], 'ramActions' => [ [ @@ -16961,12 +8473,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -16974,15 +8481,8 @@ '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' => 'Add an associated site record for an Edge Routine. This creates a new record under the specified site to trigger the execution of the Edge Routine program code.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -16995,72 +8495,35 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239007', - 'abilityTreeNodes' => [ - 'FEATUREdcdn75UYDO', - ], + 'abilityTreeNodes' => ['FEATUREdcdn75UYDO'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The routine name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-routine1', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Edge Routine function.', 'type' => 'string', 'required' => true, 'example' => 'test-routine1', 'title' => ''], ], [ 'name' => 'SiteId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '54362329990032', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '54362329990032', 'title' => ''], ], [ 'name' => 'RecordName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The record name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-record-1.example.com', - 'title' => '', - ], + 'schema' => ['description' => 'The record name.', 'type' => 'string', 'required' => true, 'example' => 'test-record-1.example.com', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', - ], - 'Status' => [ - 'description' => 'Indicates whether the operation is successful.'."\n", - 'type' => 'string', - 'example' => 'OK', - 'title' => '', - ], - 'RecordId' => [ - 'description' => 'The record ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3227405728754048', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395'], + 'Status' => ['description' => 'The operation status, which indicates success or failure.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RecordId' => ['description' => 'The record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3227405728754048', 'title' => ''], ], 'example' => '', ], @@ -17068,74 +8531,29 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'RoutineNotExist', - 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', - 'description' => 'The routine name does not exist. Check the routine name and try again.', - ], - [ - 'errorCode' => 'DependedByOthers', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'SiteParameterNotMatch', - 'errorMessage' => 'Failed to verify website parameters.Check the parameters and try again.', - 'description' => 'Failed to verify website parameters.Check the parameters and try again.', - ], - [ - 'errorCode' => 'InternalOperationError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'ParameterAlreadyExist', - 'errorMessage' => 'Parameter uniqueness verification failed. Check for duplicate parameter values.', - 'description' => 'Parameter uniqueness verification failed. Check for duplicate parameter values.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'RoutineUserServiceStatusHalt', - 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', - 'description' => 'Failed to update the configurations because you have overdue payments.', - ], - [ - 'errorCode' => 'UserOperationStatusIsLocked', - 'errorMessage' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', - 'description' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'Creation of an Edge Routine association record', - 'changeSet' => [ - [ - 'createdAt' => '2024-12-04T05:48:48.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-11-05T06:54:07.000Z', - 'description' => 'Error codes changed', + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'RoutineNotExist', 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', 'description' => 'The routine name does not exist. Check the routine name and try again.'], + ['errorCode' => 'DependedByOthers', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'SiteParameterNotMatch', 'errorMessage' => 'Failed to verify website parameters.Check the parameters and try again.', 'description' => 'Failed to verify website parameters.Check the parameters and try again.'], + ['errorCode' => 'InternalOperationError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'ParameterAlreadyExist', 'errorMessage' => 'Parameter uniqueness verification failed. Check for duplicate parameter values.', 'description' => 'Parameter uniqueness verification failed. Check for duplicate parameter values.'], + ['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' => '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.'], + ['errorCode' => 'RoutineUserServiceStatusHalt', 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', 'description' => 'Failed to update the configurations because you have overdue payments.'], + ['errorCode' => 'UserOperationStatusIsLocked', 'errorMessage' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', 'description' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.'], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create an edge routine associated record', + 'summary' => 'Adds an associated site record for an Edge Routine function. This creates a new record under the site to trigger the execution of the Edge Routine function code.', + 'changeSet' => [ + ['createdAt' => '2024-12-04T05:48:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-05T06:54:07.000Z', 'description' => 'Error codes changed'], + ], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRoutineRelatedRecord'], + ], ], 'ramActions' => [ [ @@ -17145,12 +8563,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -17158,14 +8571,9 @@ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"Status\\": \\"OK\\",\\n \\"RecordId\\": 3227405728754048\\n}","type":"json"}]', ], 'CreateRoutineRoute' => [ - 'summary' => 'Adds edge function routing configurations.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Creates an Edge Routine route configuration.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -17178,84 +8586,47 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '266190', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'RouteName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the route.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_route', - 'title' => '', - ], + 'schema' => ['description' => 'The route name.', 'type' => 'string', 'required' => true, 'example' => 'test_route', 'title' => ''], ], [ 'name' => 'RouteEnable', 'in' => 'query', - 'schema' => [ - 'description' => 'The routing switch. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'The route switch. Valid values:'."\n" + .'- on: enabled'."\n" + .'- off: disabled', 'type' => 'string', 'required' => true, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq \\"video.example.com\\")', - 'title' => '', - ], + 'schema' => ['description' => 'The rule content.', 'type' => 'string', 'required' => true, 'example' => '(http.host eq \\"video.example.com\\")', 'title' => ''], ], [ 'name' => 'RoutineName', 'in' => 'query', - 'schema' => [ - 'description' => 'The edge function name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-routine1', - 'title' => '', - ], + 'schema' => ['description' => 'The Edge Routine name.', 'type' => 'string', 'required' => true, 'example' => 'test-routine1', 'title' => ''], ], [ 'name' => 'Bypass', 'in' => 'query', 'schema' => [ - 'description' => 'Bypass mode Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", + 'description' => 'The bypass mode. Valid values:'."\n" + .'- on: enabled'."\n" + .'- off: disabled', + 'enumValueTitles' => ['off' => 'disabled.', 'on' => 'enabled.'], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, - 'enum' => [ - 'on', - 'off', - ], 'example' => 'on', 'title' => '', ], @@ -17263,54 +8634,38 @@ [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'The order in which the rule is executed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The rule execution order.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'Fallback', 'in' => 'query', 'schema' => [ - 'description' => 'The exception origin fetch switch. After you turn on this switch, if a function exception occurs, such as CPU usage exceeding the upper limit, requests are sent back to the origin. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", + 'description' => 'The back-to-origin on exception switch. When enabled, if the function encounters an exception such as CPU usage exceeding the limit, the request falls back to the origin server. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'disabled.', 'on' => 'enabled.'], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, - 'enum' => [ - 'on', - 'off', - ], 'example' => 'on', 'title' => '', ], ], + [ + 'name' => 'Timeout', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The Edge Routine timeout period. Valid values: 5 to 60. Unit: seconds.', 'type' => 'string', 'example' => '5', 'required' => false], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n", - ], - 'ConfigId' => [ - 'description' => 'The configuration ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '35281609698****', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n"], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '35281609698****', 'title' => ''], ], 'example' => '', ], @@ -17318,156 +8673,47 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidRoutine', - 'errorMessage' => 'The name of routine is invalid.', - 'description' => 'Edge function name is illegal.', - ], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidRoutine', 'errorMessage' => 'The name of routine is invalid.', 'description' => 'Edge function name is illegal.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\\\n\\",\\n \\"ConfigId\\": 0\\n}","type":"json"}]', - 'title' => 'CreateRoutineRoute', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'Create an edge routine route configuration', 'changeSet' => [ - [ - 'createdAt' => '2025-06-25T05:35:35.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-06-25T05:35:35.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '20', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateRoutineRoute', - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRoutineRoute'], ], ], 'ramActions' => [ @@ -17478,25 +8724,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], ], 'CreateScheduledPreloadExecutions' => [ - 'summary' => 'Creates scheduled prefetch plans.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Creates execution plans for batch scheduled prefetch tasks.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -17509,66 +8746,29 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239296', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4TTNAL', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4TTNAL'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the prefetch task, which is generated by calling the [CreateScheduledPreloadJob](~~2850459~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '665d3af3621bccf3fe29e1a4', - 'title' => '', - ], + 'schema' => ['description' => 'The prefetch task ID, which is generated by calling the [CreateScheduledPreloadJob](~~2850459~~) operation.', 'type' => 'string', 'required' => false, 'example' => '665d3af3621bccf3fe29e1a4', 'title' => ''], ], [ 'name' => 'Executions', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The scheduled prefetch plans to create.'."\n", + 'description' => 'The list of execution plans to be added for scheduled prefetch tasks.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the prefetch plans.'."\n", + 'description' => 'The execution plan information.', 'type' => 'object', 'properties' => [ - 'StartTime' => [ - 'description' => 'The start time of the prefetch plans.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2024-06-03T16:00:00Z', - 'title' => '', - ], - 'EndTime' => [ - 'description' => 'The end time of the prefetch plans.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2024-06-04T02:02:09Z', - 'title' => '', - ], - 'Interval' => [ - 'description' => 'The time interval between each batch execution. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'minimum' => '1', - 'example' => '30', - 'title' => '', - ], - 'SliceLen' => [ - 'description' => 'The number of URLs prefetched in each batch.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'title' => '', - ], + 'StartTime' => ['description' => 'The start time of the scheduled prefetch plan, in ISO 8601 format (such as 2024-01-01T00:00:00+Z).', 'type' => 'string', 'required' => false, 'example' => '2024-06-03T16:00:00Z', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the scheduled prefetch plan, in ISO 8601 format (such as 2024-01-01T00:00:00+Z).', 'type' => 'string', 'required' => false, 'example' => '2024-06-04T02:02:09Z', 'title' => ''], + 'Interval' => ['description' => 'The interval between each batch execution of the scheduled prefetch plan. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '30', 'title' => ''], + 'SliceLen' => ['description' => 'The number of URLs to prefetch per batch.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'title' => ''], ], 'required' => false, 'title' => '', @@ -17585,78 +8785,30 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229'], 'FailedExecutions' => [ - 'description' => 'The information about prefetch plans that failed to be created.'."\n", + 'description' => 'The information about prefetch plans that failed to be added.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the prefetch plan.'."\n", - 'type' => 'string', - 'example' => '66599bd7397885b43804901c', - 'title' => '', - ], - 'StartTime' => [ - 'description' => 'The start time of the prefetch plans.'."\n", - 'type' => 'string', - 'example' => '2024-06-02T02:43:35Z', - 'title' => '', - ], - 'EndTime' => [ - 'description' => 'The end time of the prefetch plans.'."\n", - 'type' => 'string', - 'example' => '2024-06-03T02:43:35Z', - 'title' => '', - ], - 'Interval' => [ - 'description' => 'The time interval between each batch execution. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - 'title' => '', - ], - 'SliceLen' => [ - 'description' => 'The number of URLs prefetched in each batch.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the prefetch plan. Valid values:'."\n" - ."\n" - .'* **waiting**'."\n" - .'* **running**'."\n" - .'* **finished**'."\n" - .'* **failed**'."\n" - .'* **stopped**', - 'type' => 'string', - 'example' => 'running', - 'title' => '', - ], - 'JobId' => [ - 'description' => 'The ID of the prefetch task.'."\n", - 'type' => 'string', - 'example' => '665d3af3621bccf3fe29e1a4', - 'title' => '', - ], - 'AliUid' => [ - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => '15685865xxx14622', - 'title' => '', - ], + 'Id' => ['description' => 'The prefetch plan ID.', 'type' => 'string', 'example' => '66599bd7397885b43804901c', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the scheduled prefetch plan, in ISO 8601 format (such as 2024-01-01T00:00:00+Z).', 'type' => 'string', 'example' => '2024-06-02T02:43:35Z', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the scheduled prefetch plan, in ISO 8601 format (such as 2024-01-01T00:00:00+Z).', 'type' => 'string', 'example' => '2024-06-03T02:43:35Z', 'title' => ''], + 'Interval' => ['description' => 'The interval between each batch execution of the scheduled prefetch plan. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'SliceLen' => ['description' => 'The number of URLs to prefetch per batch.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Status' => ['description' => 'The status of the scheduled prefetch plan. Valid values:'."\n" + .'- **waiting**: Waiting to be executed.'."\n" + .'- **running**: Being executed.'."\n" + .'- **finished**: Execution completed.'."\n" + .'- **failed**: Execution failed.'."\n" + .'- **stopped**: Execution paused.', 'type' => 'string', 'example' => 'running', 'title' => ''], + 'JobId' => ['description' => 'The prefetch task ID.', 'type' => 'string', 'example' => '665d3af3621bccf3fe29e1a4', 'title' => ''], + 'AliUid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '15685865xxx14622', 'title' => ''], ], 'description' => '', 'title' => '', @@ -17666,86 +8818,32 @@ 'example' => '', ], 'FailedMessages' => [ - 'description' => 'The information about plan failures.'."\n", + 'description' => 'The list of failure messages for plans that failed to be added.', 'type' => 'array', - 'items' => [ - 'description' => 'The failure information.'."\n", - 'type' => 'string', - 'example' => 'execution id: 66599bd7397885b43804921c, error: end time is before start time.', - 'title' => '', - ], + 'items' => ['description' => 'The failure message.', 'type' => 'string', 'example' => 'execution id: 66599bd7397885b43804921c, error: end time is before start time.', 'title' => ''], 'title' => '', 'example' => '', ], - 'SuccessCount' => [ - 'description' => 'The number of prefetch plans that are created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - 'title' => '', - ], + 'SuccessCount' => ['description' => 'The number of prefetch plans that were successfully added.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], 'SuccessExecutions' => [ - 'description' => 'The information about created prefetch plans.'."\n", + 'description' => 'The information about prefetch plans that were successfully added.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the prefetch plan.'."\n", - 'type' => 'string', - 'example' => '66599bd7397885b43804901c', - 'title' => '', - ], - 'StartTime' => [ - 'description' => 'The start time of the prefetch plans.'."\n", - 'type' => 'string', - 'example' => '2024-06-02T02:43:35Z', - 'title' => '', - ], - 'EndTime' => [ - 'description' => 'The end time of the prefetch plans.'."\n", - 'type' => 'string', - 'example' => '2024-06-03T02:43:35Z', - 'title' => '', - ], - 'Interval' => [ - 'description' => 'The time interval between each batch execution. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - 'title' => '', - ], - 'SliceLen' => [ - 'description' => 'The number of URLs prefetched in each batch.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the prefetch plan. Valid values:'."\n" - ."\n" - .'* **waiting**'."\n" - .'* **running**'."\n" - .'* **finished**'."\n" - .'* **failed**'."\n" - .'* **stopped**', - 'type' => 'string', - 'example' => 'failed', - 'title' => '', - ], - 'JobId' => [ - 'description' => 'The ID of the prefetch task.'."\n", - 'type' => 'string', - 'example' => '665d3af3621bccf3fe29e1a4', - 'title' => '', - ], - 'AliUid' => [ - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => '15685865xxx14622', - 'title' => '', - ], + 'Id' => ['description' => 'The prefetch plan ID.', 'type' => 'string', 'example' => '66599bd7397885b43804901c', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the scheduled prefetch plan, in ISO 8601 format (such as 2024-01-01T00:00:00+Z).', 'type' => 'string', 'example' => '2024-06-02T02:43:35Z', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the scheduled prefetch plan, in ISO 8601 format (such as 2024-01-01T00:00:00+Z).', 'type' => 'string', 'example' => '2024-06-03T02:43:35Z', 'title' => ''], + 'Interval' => ['description' => 'The interval between each batch execution of the scheduled prefetch plan. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'SliceLen' => ['description' => 'The number of URLs to prefetch per batch.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Status' => ['description' => 'The status of the scheduled prefetch plan. Valid values:'."\n" + .'- **waiting**: Waiting to be executed.'."\n" + .'- **running**: Being executed.'."\n" + .'- **finished**: Execution completed.'."\n" + .'- **failed**: Execution failed.'."\n" + .'- **stopped**: Execution paused.', 'type' => 'string', 'example' => 'failed', 'title' => ''], + 'JobId' => ['description' => 'The prefetch task ID.', 'type' => 'string', 'example' => '665d3af3621bccf3fe29e1a4', 'title' => ''], + 'AliUid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '15685865xxx14622', 'title' => ''], ], 'description' => '', 'title' => '', @@ -17754,13 +8852,7 @@ 'title' => '', 'example' => '', ], - 'TotalCount' => [ - 'description' => 'The total number of new plans requested.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - 'title' => '', - ], + 'TotalCount' => ['description' => 'The total number of plans requested to be added.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], 'example' => '', ], @@ -17768,110 +8860,39 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], - [ - 'errorCode' => 'InvalidJob.JobCountOfSiteFull', - 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', - 'description' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', - ], - [ - 'errorCode' => 'InvalidParameter.ObjectId', - 'errorMessage' => 'Invalid task ID or execution plan ID.', - 'description' => 'Invalid task ID or execution plan ID.', - ], - [ - 'errorCode' => 'MissingOssUrl', - 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', - 'description' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', - ], - [ - 'errorCode' => 'MissingUrlList', - 'errorMessage' => 'Enter the URLs you want to prefetch.', - 'description' => 'Enter the URLs you want to prefetch.', - ], - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests.Please try again later.', - 'description' => 'Requests are too frequent, please try again later.', - ], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'InvalidJob.JobCountOfSiteFull', 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', 'description' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.'], + ['errorCode' => 'InvalidParameter.ObjectId', 'errorMessage' => 'Invalid task ID or execution plan ID.', 'description' => 'Invalid task ID or execution plan ID.'], + ['errorCode' => 'MissingOssUrl', 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', 'description' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.'], + ['errorCode' => 'MissingUrlList', 'errorMessage' => 'Enter the URLs you want to prefetch.', 'description' => 'Enter the URLs you want to prefetch.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], ], 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' => '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.', - ], + ['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' => '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.'], ], [ - [ - 'errorCode' => 'InvalidJob.NotFound', - 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', - 'description' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', - ], - [ - 'errorCode' => 'LogNotFound', - 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', - 'description' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', - ], - [ - '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' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.', - ], + ['errorCode' => 'InvalidJob.NotFound', 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', 'description' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.'], + ['errorCode' => 'LogNotFound', 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', 'description' => 'Failed to query the log. Check whether the task ID and execution ID are valid.'], + ['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' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', - 'title' => 'CreateScheduledPreloadExecutions', + 'title' => 'Create execution plans for batch scheduled prefetch tasks', 'changeSet' => [ - [ - 'createdAt' => '2024-11-12T03:12:20.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2024-11-12T03:12:20.000Z', 'description' => 'Request parameters changed'], ], '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateScheduledPreloadExecutions'], ], ], + 'ramActions' => [], ], 'CreateScheduledPreloadJob' => [ - 'summary' => 'Adds a scheduled prefetch task.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Add a scheduled prefetch task.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -17884,196 +8905,85 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239344', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4TTNAL', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4TTNAL'], ], 'parameters' => [ [ 'name' => 'InsertWay', 'in' => 'formData', 'schema' => [ - 'description' => 'The method to submit URLs to be prefetched.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* **textBox**'."\n" - .'* **oss**', + 'description' => 'The method of uploading prefetch files. Text box and OSS upload methods are supported.', + 'enumValueTitles' => ['textBox' => 'Enter URLs one by one via the text box', 'oss' => 'Import URLs in bulk via an OSS file'], 'type' => 'string', 'required' => true, + 'enum' => ['textBox', 'oss'], 'example' => 'oss', - 'enum' => [ - 'textBox', - 'oss', - ], 'title' => '', ], ], [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the scheduled prefetch task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'example', - 'maxLength' => 128, - 'minLength' => 1, - 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the scheduled prefetch task.', 'type' => 'string', 'required' => true, 'maxLength' => 128, 'minLength' => 1, 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', 'example' => 'example', 'title' => ''], ], [ 'name' => 'OssUrl', 'in' => 'formData', - 'schema' => [ - 'description' => 'The URL of the OSS object that stores the URLs to be prefetched.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7', - 'title' => '', - ], + 'schema' => ['description' => 'The OSS file for the scheduled prefetch task. Enter the address of the OSS file.'."\n" + .'Note: The OSS file contains the URLs that you want to prefetch.', 'type' => 'string', 'required' => false, 'example' => 'https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7', 'title' => ''], ], [ 'name' => 'SiteId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '190007158391808', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can obtain it by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '190007158391808', 'title' => ''], ], [ 'name' => 'UrlList', 'in' => 'formData', - 'schema' => [ - 'description' => 'The URLs to be prefetched. This parameter is required if you set InsertWay to textBox.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://testurl.com/a.txt'."\n" - .'http://testurl.com/b.txt', - 'title' => '', - ], + 'schema' => ['description' => 'The list of URLs to prefetch. This parameter is used when you upload prefetch files via the text box.', 'type' => 'string', 'required' => false, 'example' => 'http://testurl.com/a.txt'."\n" + .'http://testurl.com/b.txt', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247B78', - ], - 'AliUid' => [ - 'title' => '', - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => '15685865xxx14622', - ], - 'CreatedAt' => [ - 'title' => '', - 'description' => 'The time when the task was created.'."\n", - 'type' => 'string', - 'example' => '2023-06-05T10:04:20+0800', - ], - 'Domains' => [ - 'title' => '', - 'description' => 'The domain names to be prefetched.'."\n", - 'type' => 'string', - 'example' => 'testurl.com', - ], - 'ErrorInfo' => [ - 'title' => '', - 'description' => 'The error message. Multiple error messages are separated by commas (,). Valid values:'."\n" - ."\n" - .'* **InvalidUrl**: The URL format is invalid.'."\n" - .'* **InvalidDomain**: The domain name fails the domain ownership verification.'."\n" - .'* **QuotaExcess**: the quota limit has been reached.'."\n" - .'* **OtherErrors**: other errors.', - 'type' => 'string', - 'example' => 'InvalidDomain', - ], - 'FailedFileOss' => [ - 'title' => '', - 'description' => 'The URL of the OSS object that stores a list of URLs that failed the conditional check for prefetching.'."\n", - 'type' => 'string', - 'example' => 'https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7', - ], - 'FileId' => [ - 'title' => '', - 'description' => 'The ID of the URL list file, which can be used during downloads.'."\n", - 'type' => 'string', - 'example' => '665d3b48621bccf3fe29e1a7', - ], - 'Id' => [ - 'title' => '', - 'description' => 'The ID of the scheduled prefetch task.'."\n", - 'type' => 'string', - 'example' => '665d3af3621bccf3fe29e1a4', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247B78'], + 'AliUid' => ['title' => '', 'description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '15685865xxx14622'], + 'CreatedAt' => ['title' => '', 'description' => 'The time when the task was created, in ISO 8601 format (for example, 2024-01-01T00:00:00+08:00).', 'type' => 'string', 'example' => '2023-06-05T10:04:20+0800'], + 'Domains' => ['title' => '', 'description' => 'The list of prefetch domains.', 'type' => 'string', 'example' => 'testurl.com'], + 'ErrorInfo' => ['title' => '', 'description' => 'The error information. Multiple errors are separated by commas:'."\n" + .'- **InvalidUrl**: The URL format is invalid.'."\n" + .'- **InvalidDomain**: The domain ownership verification failed.'."\n" + .'- **QuotaExcess**: The quota limit has been exceeded.'."\n" + .'- **OtherErrors**: Other errors.', 'type' => 'string', 'example' => 'InvalidDomain'], + 'FailedFileOss' => ['title' => '', 'description' => 'The OSS address of the failed file.', 'type' => 'string', 'example' => 'https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7'], + 'FileId' => ['title' => '', 'description' => 'The URL list file ID, used for downloading.', 'type' => 'string', 'example' => '665d3b48621bccf3fe29e1a7'], + 'Id' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => '665d3af3621bccf3fe29e1a4'], 'InsertWay' => [ 'title' => '', - 'description' => 'The method to submit the URLs to be prefetched.'."\n", + 'description' => 'The URL insertion method.', + 'enumValueTitles' => ['oss' => 'Import URLs in bulk via an OSS file', 'testBox' => 'Enter URLs one by one via the text box'], 'type' => 'string', + 'enum' => ['file', 'url'], 'example' => 'oss', - 'enum' => [ - 'file', - 'url', - ], - ], - 'Name' => [ - 'title' => '', - 'description' => 'The task name.'."\n", - 'type' => 'string', - 'example' => 'example', - ], - 'SiteId' => [ - 'title' => '', - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '190007158391808', - ], - 'TaskSubmitted' => [ - 'title' => '', - 'description' => 'The number of submitted prefetch tasks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', ], + 'Name' => ['title' => '', 'description' => 'The task name.', 'type' => 'string', 'example' => 'example'], + 'SiteId' => ['title' => '', 'description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '190007158391808'], + 'TaskSubmitted' => ['title' => '', 'description' => 'The number of URLs that have been submitted to the system for prefetch tasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'TaskType' => [ 'title' => '', - 'description' => 'The task type (refresh or preload).'."\n", + 'description' => 'The task type (refresh/prefetch).', + 'enumValueTitles' => ['path' => 'Directory refresh', 'refresh' => 'URL refresh', 'preload' => 'URL prefetch'], 'type' => 'string', + 'enum' => ['preload', 'refresh', 'path'], 'example' => 'preload', - 'enum' => [ - 'preload', - 'refresh', - 'path', - ], - ], - 'UrlCount' => [ - 'title' => '', - 'description' => 'The total number of URLs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'UrlSubmitted' => [ - 'title' => '', - 'description' => 'The number of submitted URLs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', ], + 'UrlCount' => ['title' => '', 'description' => 'The total number of URLs.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'UrlSubmitted' => ['title' => '', 'description' => 'The number of submitted URLs.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], 'example' => '', ], @@ -18081,108 +8991,41 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], - [ - 'errorCode' => 'InvalidJob.JobCountOfSiteFull', - 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', - 'description' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', - ], - [ - 'errorCode' => 'InvalidParameter.ObjectId', - 'errorMessage' => 'Invalid task ID or execution plan ID.', - 'description' => 'Invalid task ID or execution plan ID.', - ], - [ - 'errorCode' => 'MissingOssUrl', - 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', - 'description' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', - ], - [ - 'errorCode' => 'MissingUrlList', - 'errorMessage' => 'Enter the URLs you want to prefetch.', - 'description' => 'Enter the URLs you want to prefetch.', - ], - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests.Please try again later.', - 'description' => 'Requests are too frequent, please try again later.', - ], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'InvalidJob.JobCountOfSiteFull', 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', 'description' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.'], + ['errorCode' => 'InvalidParameter.ObjectId', 'errorMessage' => 'Invalid task ID or execution plan ID.', 'description' => 'Invalid task ID or execution plan ID.'], + ['errorCode' => 'MissingOssUrl', 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', 'description' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.'], + ['errorCode' => 'MissingUrlList', 'errorMessage' => 'Enter the URLs you want to prefetch.', 'description' => 'Enter the URLs you want to prefetch.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], ], 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' => '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.', - ], + ['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' => '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.'], ], [ - [ - 'errorCode' => 'InvalidJob.NotFound', - 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', - 'description' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', - ], - [ - 'errorCode' => 'LogNotFound', - 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', - 'description' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', - ], - [ - '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' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.', - ], + ['errorCode' => 'InvalidJob.NotFound', 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', 'description' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.'], + ['errorCode' => 'LogNotFound', 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', 'description' => 'Failed to query the log. Check whether the task ID and execution ID are valid.'], + ['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' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], '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"}]', - 'title' => 'CreateScheduledPreloadJob', + 'title' => 'Create a Scheduled Prefetch Task', '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateScheduledPreloadJob'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], + 'ramActions' => [], ], 'CreateSite' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Creates a site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -18195,9 +9038,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239619', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ @@ -18205,31 +9046,21 @@ 'name' => 'SiteName', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '', - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'example.com', - ], + 'schema' => ['title' => '', 'description' => 'The site name.', 'type' => 'string', 'required' => true, 'example' => 'example.com'], ], [ 'name' => 'Coverage', 'in' => 'query', 'schema' => [ - 'description' => 'The service location. Valid values:'."\n" - ."\n" - .'* **domestic**: the Chinese mainland'."\n" - .'* **global**: global'."\n" - .'* **overseas**: outside the Chinese mainland'."\n", + 'description' => 'The acceleration region. Valid values:'."\n" + .'- **domestic**: the Chinese mainland only.'."\n" + .'- **global**: global.'."\n" + .'- **overseas**: global (excluding the Chinese mainland).', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, + 'enum' => ['global', 'domestic', 'overseas'], 'example' => 'domestic', - 'enum' => [ - 'global', - 'domestic', - 'overseas', - ], 'title' => '', ], ], @@ -18237,41 +9068,27 @@ 'name' => 'AccessType', 'in' => 'query', 'schema' => [ - 'description' => 'The DNS setup. Valid values:'."\n" + 'description' => 'The access type of the site. Valid values:'."\n" ."\n" - .'* **NS**'."\n" - .'* **CNAME**'."\n", + .'- **NS**: access by using managed NS.'."\n" + .'- **CNAME**: access by configuring a CNAME record.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, + 'enum' => ['NS', 'CNAME'], 'example' => 'NS', - 'enum' => [ - 'NS', - 'CNAME', - ], 'title' => '', ], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID, which can be obtained by calling the [ListUserRatePlanInstances](~~2852398~~) operation. Specify at least one of the instance ID and website ID. If you specify both of them, the instance ID is used.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dbaudit-cn-nwy349jdb03'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The instance ID. You can obtain the instance ID by calling the [ListUserRatePlanInstances](~~2852398~~) operation. You must specify at least one of the instance ID and site ID. If both are specified, the instance ID takes precedence.', 'type' => 'string', 'required' => true, 'example' => 'dbaudit-cn-nwy349jdb03'."\n", 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group. If you leave this parameter empty, the system uses the default resource group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmw4znnok****', - 'title' => '', - ], + 'schema' => ['description' => 'The resource group ID. If you do not specify this parameter, the system automatically uses the default resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmw4znnok****', 'title' => ''], ], ], 'responses' => [ @@ -18279,31 +9096,10 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE', - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567890123', - 'title' => '', - ], - 'NameServerList' => [ - 'description' => 'The nameservers assigned by ESA. The values are separated by commas (,). This parameter is returned if you set AccessType to NS. In this case, you must change the nameservers of your domain to the assigned ones. Then, you can verify the domain ownership and activate your website.'."\n", - 'type' => 'string', - 'example' => 'ns1.example.com,ns2.example.com', - 'title' => '', - ], - 'VerifyCode' => [ - 'description' => 'The verification code for the website. If you set AccessType to CNAME, you need to add a TXT record whose hostname is **\\_esaauth.\\[websiteDomainName]** and record value is the value of VerifyCode to the DNS records of your domain. ****Then, you can verify the domain ownership and activate your website.'."\n", - 'type' => 'string', - 'example' => 'verify_aah9dioasmov****', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE', 'title' => ''], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''], + 'NameServerList' => ['description' => 'The list of name servers assigned to the site, separated by commas (,). This field has a value when the access type of the site is NS. You need to change the DNS servers of the site to these name servers. Then you can verify the site ownership and activate the site.', 'type' => 'string', 'example' => 'ns1.example.com,ns2.example.com', 'title' => ''], + 'VerifyCode' => ['description' => 'The verification code of the site. When the access type of the site is CNAME, you need to add a TXT record with the record name **_esaauth.[site name]** and the record value set to the **verification code** on the DNS server of the site. Then you can verify the site ownership and activate the site.', 'type' => 'string', 'example' => 'verify_aah9dioasmov****', 'title' => ''], ], 'description' => '', 'title' => '', @@ -18313,113 +9109,55 @@ ], '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'InvalidParameter.SiteName', - 'errorMessage' => 'Invalid website name. Specify a valid name that contains letters and digits and does not contain special characters.', - 'description' => 'Invalid website name. Specify a valid name that contains letters and digits and does not contain special characters.', - ], - [ - 'errorCode' => 'QuotaExceed.SiteCount', - 'errorMessage' => 'The maximum number of websites associated with your plan has been reached.', - 'description' => 'The maximum number of websites associated with your plan has been reached.', - ], - [ - 'errorCode' => 'Site.Conflict', - 'errorMessage' => 'Duplicate website names exist across multiple accounts. Rename or delete one and try again.', - 'description' => 'Duplicate website names exist across multiple accounts. Rename or delete one and try again.', - ], - [ - 'errorCode' => 'Site.AlreadyExist', - 'errorMessage' => 'The website name you specified already exists. Try with another name.', - 'description' => 'The website name you specified already exists. Try with another name.', - ], - [ - 'errorCode' => 'SubSiteUnavailable', - 'errorMessage' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.', - 'description' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.', - ], - [ - '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' => 'The selected location is unavailable in your plan. Change the location to one that is covered by the plan and try again.', - ], - [ - '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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.', - ], - [ - 'errorCode' => 'InvalidSiteName', - 'errorMessage' => 'Invalid website name. Check and try again.', - 'description' => 'Invalid website name. Check and try again.', - ], - [ - 'errorCode' => 'Site.InBlacklist', - 'errorMessage' => 'The site name is in the blacklist.', - 'description' => 'The site name is in the blacklist.', - ], - [ - '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' => '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.', - ], - ], - ], - 'title' => 'CreateSite', - 'summary' => 'Adds a website.', - 'description' => '* Make sure that you have an available plan before you add a website.'."\n" - .'* Make sure that your website domain name has an ICP filing if the location you want to specify covers the Chinese mainland.'."\n", - 'changeSet' => [ - [ - 'createdAt' => '2024-10-10T02:01:25.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-10-08T03:26:26.000Z', - 'description' => 'Error codes changed', + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'InvalidParameter.SiteName', 'errorMessage' => 'Invalid website name. Specify a valid name that contains letters and digits and does not contain special characters.', 'description' => 'Invalid website name. Specify a valid name that contains letters and digits and does not contain special characters.'], + ['errorCode' => 'QuotaExceed.SiteCount', 'errorMessage' => 'The maximum number of websites associated with your plan has been reached.', 'description' => 'The maximum number of websites associated with your plan has been reached.'], + ['errorCode' => 'Site.Conflict', 'errorMessage' => 'Duplicate website names exist across multiple accounts. Rename or delete one and try again.', 'description' => 'Duplicate website names exist across multiple accounts. Rename or delete one and try again.'], + ['errorCode' => 'Site.AlreadyExist', 'errorMessage' => 'The website name you specified already exists. Try with another name.', 'description' => 'The website name you specified already exists. Try with another name.'], + ['errorCode' => 'SubSiteUnavailable', 'errorMessage' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.', 'description' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.'], + ['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' => 'The selected location is unavailable in your plan. Change the location to one that is covered by the plan and try again.'], + ['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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.'], + ['errorCode' => 'InvalidSiteName', 'errorMessage' => 'Invalid website name. Check and try again.', 'description' => 'Invalid website name. Check and try again.'], + ['errorCode' => 'Site.InBlacklist', 'errorMessage' => 'The site name is in the blacklist.', 'description' => 'The site name is in the blacklist.'], + ['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' => '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.'], + ['errorCode' => 'NotInternationalRealIdentity', 'errorMessage' => 'Real-name registration is required for services offered in Mainland China.', 'description' => 'You have not passed real-name verification. According to the regulations issued by MIIT, you must pass real-name verification if you want to purchase information services in the Chinese mainland.'], ], ], + '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"}]', + 'title' => 'Create a site', + 'description' => '- Before creating a site, you must have an active plan instance.'."\n" + .'- If the acceleration area is set to the Chinese mainland only or global, the site domain name must have a completed Internet Content Provider (ICP) filing.'."\n" + .'- Each user can invoke this operation up to 100 times per hour.', + 'changeSet' => [ + ['createdAt' => '2024-10-10T02:01:25.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-10-08T03:26:26.000Z', 'description' => 'Error codes changed'], + ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateSite', + ['threshold' => '100', 'countWindow' => 3600, 'regionId' => '*', 'api' => 'CreateSite'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateSite', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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' => 'Adds the configuration of custom request header, response header, and cookie fields that are used to capture logs of a website.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -18431,22 +9169,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238449', - 'abilityTreeNodes' => [ - 'FEATUREdcdn9K10I1', - ], + 'abilityTreeNodes' => ['FEATUREdcdn9K10I1'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '11223', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11223', 'title' => ''], ], [ 'name' => 'RequestHeaders', @@ -18455,13 +9184,7 @@ 'schema' => [ 'description' => 'The request header fields.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The request header field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'x-acs-request-id', - 'title' => '', - ], + 'items' => ['description' => 'The request header field.'."\n", 'type' => 'string', 'required' => false, 'example' => 'x-acs-request-id', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', @@ -18474,13 +9197,7 @@ 'schema' => [ 'description' => 'The response header fields.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The response header field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'X_Swift_Error', - 'title' => '', - ], + 'items' => ['description' => 'The response header field.'."\n", 'type' => 'string', 'required' => false, 'example' => 'X_Swift_Error', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', @@ -18493,13 +9210,7 @@ 'schema' => [ 'description' => 'The cookie fields.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The cookie field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sessionId', - 'title' => '', - ], + 'items' => ['description' => 'The cookie field.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sessionId', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', @@ -18513,12 +9224,7 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '073bd613-6e72-4461-b6bc-19326dfc6a9c', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '073bd613-6e72-4461-b6bc-19326dfc6a9c'], ], 'example' => '', ], @@ -18526,47 +9232,25 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], ], 403 => [ - [ - 'errorCode' => 'RealTimeLog.RegexpCheckFail', - 'errorMessage' => 'Invalid characters exist in your parameter configurations. Check your configurations and try again.', - 'description' => 'Invalid characters exist in your parameter configurations. Check your configurations and try again.', - ], + ['errorCode' => 'RealTimeLog.RegexpCheckFail', 'errorMessage' => 'Invalid characters exist in your parameter configurations. Check your configurations and try again.', 'description' => 'Invalid characters exist in your parameter configurations. Check your configurations and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"073bd613-6e72-4461-b6bc-19326dfc6a9c\\"\\n}","type":"json"}]', 'title' => 'CreateSiteCustomLog', 'description' => '* **Custom field limits**: The key name of a custom field can contain only letters, digits, underscores (\\_), and spaces. The key name cannot contain other characters. Otherwise, errors may occur.'."\n" .'* **Parameter passing**: Submit `SiteId`, `RequestHeaders`, `ResponseHeaders`, and `Cookies` by using `formData`. Each array element matches a custom field name.'."\n" .'* **(Required) SiteId**: Although `SiteId` is not marked as required in the Required column, you must specify a website ID by using this parameter when you can call this API operation.'."\n", 'changeSet' => [ - [ - 'createdAt' => '2024-09-27T05:57:03.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-27T05:57:03.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateSiteCustomLog', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSiteCustomLog'], ], ], 'ramActions' => [ @@ -18577,12 +9261,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -18594,13 +9273,9 @@ ], ], 'CreateSiteDeliveryTask' => [ - 'summary' => 'Creates a real-time log delivery task.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Create a real-time log shipping task.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -18613,347 +9288,151 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239178', - 'abilityTreeNodes' => [ - 'FEATUREdcdn9K10I1', - ], + 'abilityTreeNodes' => ['FEATUREdcdn9K10I1'], ], 'parameters' => [ [ 'name' => 'BusinessType', 'in' => 'formData', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '', - 'description' => 'The log category. Valid values:'."\n" - ."\n" - .'* **dcdn_log_access_l1** (default): access logs.'."\n" - .'* **dcdn_log_er**: Edge Routine logs.'."\n" - .'* **dcdn_log_waf**: firewall logs.'."\n" - .'* **dcdn_log_ipa**: TCP/UDP proxy logs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dcdn_log_access_l1', - ], + 'schema' => ['description' => 'The business type. Valid values:'."\n" + ."\n" + .'- **dcdn\\_log\\_access\\_l1** (default): access log.'."\n" + ."\n" + .'- **dcdn\\_log\\_er**: edge function log.'."\n" + ."\n" + .'- **dcdn\\_log\\_waf**: WAF protection log.'."\n" + ."\n" + .'- **dcdn\\_log\\_ipa**: Layer-4 acceleration log.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'dcdn_log_access_l1'], ], [ 'name' => 'SiteId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12312312112***', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the site. You can call the [ListSites](~~2850189~~) operation to obtain the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12312312112***', 'title' => ''], ], [ 'name' => 'DataCenter', 'in' => 'formData', - 'schema' => [ - 'description' => 'The data center. Valid values:'."\n" - ."\n" - .'* cn: the Chinese mainland.'."\n" - .'* oversea: outside the Chinese mainland.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn', - 'title' => '', - ], + 'schema' => ['description' => 'The data center. Valid values:'."\n" + ."\n" + .'- **cn**: Chinese mainland.'."\n" + ."\n" + .'- **oversea**: regions outside the Chinese mainland.', 'type' => 'string', 'required' => false, 'example' => 'cn', 'title' => ''], ], [ 'name' => 'TaskName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the delivery task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dcdn-test-task', - 'title' => '', - ], + 'schema' => ['description' => 'The task name.', 'type' => 'string', 'required' => true, 'example' => 'dcdn-test-task', 'title' => ''], ], [ 'name' => 'FieldName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The log fields, which are separated by commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'user_agent,ip_adress,ip_port', - 'title' => '', - ], + 'schema' => ['description' => 'The log fields for delivery. Separate multiple fields with a comma (,).', 'type' => 'string', 'required' => true, 'example' => 'user_agent,ip_adress,ip_port', 'title' => ''], ], [ 'name' => 'DeliveryType', 'in' => 'formData', + 'schema' => ['description' => 'The type of the delivery destination. Valid values:'."\n" + ."\n" + .'- **sls**: Log Service.'."\n" + ."\n" + .'- **http**: an HTTP service.'."\n" + ."\n" + .'- **aws3**: Amazon S3.'."\n" + ."\n" + .'- **oss**: Object Storage Service.'."\n" + ."\n" + .'- **kafka**: a Kafka service.'."\n" + ."\n" + .'- **aws3cmpt**: an Amazon S3-compatible service.', 'type' => 'string', 'required' => true, 'example' => 'sls', 'title' => ''], + ], + [ + 'name' => 'DiscardRate', + 'in' => 'formData', + 'schema' => ['description' => 'The discard rate. If you do not specify this parameter, the default value 0 is used.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.0', 'title' => ''], + ], + [ + 'name' => 'S3Delivery', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The destination of the delivery. Valid values:'."\n" - ."\n" - .'* sls: Alibaba Cloud Simple Log Service (SLS).'."\n" - .'* http: HTTP server.'."\n" - .'* aws3: Amazon Simple Storage Service (S3).'."\n" - .'* oss: Alibaba Cloud Object Storage Service (OSS).'."\n" - .'* kafka: Kafka.'."\n" - .'* aws3cmpt: S3-compatible storage service.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'sls', + 'description' => 'The parameters for delivering logs to an Amazon S3 bucket or an S3-compatible service.', + 'type' => 'object', + 'properties' => [ + 'Region' => ['description' => 'The region where the service is located.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], + 'BucketPath' => ['description' => 'The bucket path.', 'type' => 'string', 'required' => false, 'example' => 'logriver-test/log', 'title' => ''], + 'AccessKey' => ['description' => 'The AccessKey ID of the Alibaba Cloud account or RAM user.', 'type' => 'string', 'required' => false, 'example' => 'yourAccessKeyID', 'title' => ''], + 'SecretKey' => ['description' => 'The AccessKey secret of the S3 account.', 'type' => 'string', 'required' => false, 'example' => 'LDSIKh***', 'title' => ''], + 'Endpoint' => ['description' => 'The endpoint of the server. This parameter is required when S3Cmpt is set to true.'."\n" + ."\n" + .'> For S3-compatible services, you must configure DNS resolution for a domain name that is spliced by the bucket and endpoint. For example, if Endpoint is set to example.com and Bucket is set to demo, the actual delivery address is demo.example.com.', 'type' => 'string', 'required' => false, 'example' => 'https://s3.oss-cn-hangzhou.aliyuncs.com', 'title' => ''], + 'PrefixPath' => ['description' => 'The storage path prefix.', 'type' => 'string', 'required' => false, 'example' => 'logriver-test/log', 'title' => ''], + 'S3Cmpt' => ['description' => 'Specifies whether the service is S3-compatible.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'ServerSideEncryption' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'VertifyType' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DiscardRate', + 'name' => 'OssDelivery', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The discard rate. Default value: 0.'."\n", - 'type' => 'number', - 'format' => 'float', + 'description' => 'The parameters for delivering logs to Object Storage Service (OSS).', + 'type' => 'object', + 'properties' => [ + 'Region' => ['description' => 'The region of the OSS bucket.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], + 'Aliuid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'required' => false, 'example' => '1234***', 'title' => ''], + 'BucketName' => ['description' => 'The bucket name.', 'type' => 'string', 'required' => false, 'example' => 'test_rlog', 'title' => ''], + 'PrefixPath' => ['description' => 'The prefix of the object key when logs are stored in the OSS bucket.', 'type' => 'string', 'required' => false, 'example' => 'test/', 'title' => ''], + ], 'required' => false, - 'example' => '0.0', 'title' => '', + 'example' => '', ], ], [ - 'name' => 'S3Delivery', + 'name' => 'HttpDelivery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The configurations for delivery to Amazon S3 or an S3-compatible service.'."\n", + 'description' => 'The parameters for delivering logs to an HTTP server.', 'type' => 'object', 'properties' => [ - 'Region' => [ - 'description' => 'The region ID of the service.'."\n", - 'type' => 'string', + 'DestUrl' => ['description' => 'The URL of the destination HTTP server.', 'type' => 'string', 'required' => false, 'example' => 'http://xxx.aliyun.com/v1/log/upload', 'title' => ''], + 'StandardAuthOn' => ['description' => 'Specifies whether to use standard authentication.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'StandardAuthParam' => [ + 'description' => 'The standard authentication parameters.', + 'type' => 'object', + 'properties' => [ + 'PrivateKey' => ['description' => 'The private key.', 'type' => 'string', 'required' => false, 'example' => '***', 'title' => ''], + 'ExpiredTime' => ['description' => 'The encryption timeout period.'."\n" + ."\n" + .'> The value must be greater than 0. We recommend that you set the value to 300 or greater.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '300', 'title' => ''], + 'UrlPath' => ['description' => 'The URI path for standard authentication.', 'type' => 'string', 'required' => false, 'example' => 'v1/log/upload', 'title' => ''], + ], 'required' => false, - 'example' => 'cn-beijing', - 'title' => '', - ], - 'BucketPath' => [ - 'description' => 'The directory in the bucket.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'logriver-test/log', - 'title' => '', - ], - 'AccessKey' => [ - 'description' => 'The access key ID of your Amazon S3 account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'yourAccessKeyID', - 'title' => '', - ], - 'SecretKey' => [ - 'description' => 'The secret access key of your Amazon S3 account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'LDSIKh***', - 'title' => '', - ], - 'Endpoint' => [ - 'description' => 'The endpoint. This parameter is required when the S3Cmpt parameter is set to true.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://s3.oss-cn-hangzhou.aliyuncs.com', - 'title' => '', - ], - 'PrefixPath' => [ - 'description' => 'The prefix of the path in which you want to store logs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'logriver-test/log', - 'title' => '', - ], - 'S3Cmpt' => [ - 'description' => 'Specifies whether the service is compatible with Amazon S3.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], - 'ServerSideEncryption' => [ - 'type' => 'boolean', - 'required' => false, - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'VertifyType' => [ - 'type' => 'string', - 'required' => false, - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - 'required' => false, - 'title' => '', - 'example' => '', - ], - ], - [ - 'name' => 'OssDelivery', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The configurations for delivery to OSS.'."\n", - 'type' => 'object', - 'properties' => [ - 'Region' => [ - 'description' => 'The region in which the bucket is located.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai', - 'title' => '', - ], - 'Aliuid' => [ - 'description' => 'The ID of your Alibaba Cloud account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1234***', - 'title' => '', - ], - 'BucketName' => [ - 'description' => 'The name of the OSS bucket.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_rlog', - 'title' => '', - ], - 'PrefixPath' => [ - 'description' => 'The prefix of the path in which you want to store logs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test/', - 'title' => '', - ], - ], - 'required' => false, - 'title' => '', - 'example' => '', - ], - ], - [ - 'name' => 'HttpDelivery', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The configurations for delivery to an HTTP server.'."\n", - 'type' => 'object', - 'properties' => [ - 'DestUrl' => [ - 'description' => 'The address of the HTTP server.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://xxx.aliyun.com/v1/log/upload', - 'title' => '', - ], - 'StandardAuthOn' => [ - 'description' => 'Specifies whether to use server authentication.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], - 'StandardAuthParam' => [ - 'description' => 'The authentication configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'PrivateKey' => [ - 'description' => 'The private key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '***', - 'title' => '', - ], - 'ExpiredTime' => [ - 'description' => 'The validity period of the signature.'."\n" - ."\n" - .'> The value must be greater than 0. We recommend that you specify a value that is greater than 300.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '300', - 'title' => '', - ], - 'UrlPath' => [ - 'description' => 'The URI path for server authentication.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'v1/log/upload', - 'title' => '', - ], - ], - 'required' => false, - 'title' => '', - 'example' => '', - ], - 'MaxBatchSize' => [ - 'description' => 'The maximum number of entries for each delivery.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000', - 'title' => '', - ], - 'MaxBatchMB' => [ - 'description' => 'The maximum size of data for each delivery. Unit: MB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5', - 'title' => '', - ], - 'MaxRetry' => [ - 'description' => 'The maximum number of retries.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3', - 'title' => '', - ], - 'TransformTimeout' => [ - 'description' => 'The timeout period. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - 'title' => '', - ], - 'LogBodyPrefix' => [ - 'description' => 'The prefix of the log delivery package.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cdnVersion:1.0', - 'title' => '', - ], - 'LogBodySuffix' => [ - 'description' => 'The suffix of the log delivery package.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cdnVersion:1.0', - 'title' => '', - ], - 'Compress' => [ - 'description' => 'The compression method. By default, data is not compressed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gzip', 'title' => '', + 'example' => '', ], + 'MaxBatchSize' => ['description' => 'The maximum number of log entries per delivery.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', 'title' => ''], + 'MaxBatchMB' => ['description' => 'The maximum size of a delivery, in MB.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', 'title' => ''], + 'MaxRetry' => ['description' => 'The maximum number of retries.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'title' => ''], + 'TransformTimeout' => ['description' => 'The timeout period, in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + 'LogBodyPrefix' => ['description' => 'The prefix of the delivered log package.', 'type' => 'string', 'required' => false, 'example' => 'cdnVersion:1.0', 'title' => ''], + 'LogBodySuffix' => ['description' => 'The suffix of the delivered log package.', 'type' => 'string', 'required' => false, 'example' => 'cdnVersion:1.0', 'title' => ''], + 'Compress' => ['description' => 'The compression method. By default, logs are delivered uncompressed.', 'type' => 'string', 'required' => false, 'example' => 'gzip', 'title' => ''], 'HeaderParam' => [ - 'description' => 'The custom headers.'."\n", + 'description' => 'The custom HTTP request headers.', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'object', 'properties' => [ - 'StaticValue' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'alicdn', - 'description' => 'The static variable.'."\n", - 'title' => '', - ], + 'StaticValue' => ['description' => 'The static variable.'."\n", 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], 'description' => 'The header field.'."\n", 'title' => '', @@ -18963,19 +9442,13 @@ 'example' => '', ], 'QueryParam' => [ - 'description' => 'The custom query parameters.'."\n", + 'description' => 'The custom query parameters.', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'object', 'properties' => [ - 'StaticValue' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The static variable.'."\n", - 'example' => 'alicdn', - 'title' => '', - ], + 'StaticValue' => ['description' => 'The static variable.'."\n", 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], 'description' => 'The name of the custom request parameter.'."\n", 'title' => '', @@ -18984,27 +9457,9 @@ 'title' => '', 'example' => '', ], - 'LogSplit' => [ - 'type' => 'boolean', - 'required' => false, - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'LastLogSplit' => [ - 'type' => 'boolean', - 'required' => false, - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'LogSplitWords' => [ - 'type' => 'string', - 'required' => false, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'LogSplit' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'LastLogSplit' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'LogSplitWords' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', @@ -19016,72 +9471,24 @@ 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The configurations for delivery to Kafka.'."\n", + 'description' => 'The parameters for delivering logs to a Kafka cluster.', 'type' => 'object', 'properties' => [ - 'Topic' => [ - 'description' => 'The topic.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dqc_test2', - 'title' => '', - ], - 'UserAuth' => [ - 'description' => 'Specifies whether to enable authentication.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], - 'MachanismType' => [ - 'description' => 'The encryption method.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'plain', - 'title' => '', - ], - 'UserName' => [ - 'description' => 'The username.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - 'title' => '', - ], - 'Password' => [ - 'description' => 'The password.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '***', - 'title' => '', - ], + 'Topic' => ['description' => 'The Kafka topic.', 'type' => 'string', 'required' => false, 'example' => 'dqc_test2', 'title' => ''], + 'UserAuth' => ['description' => 'Specifies whether to enable user authentication.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'MachanismType' => ['description' => 'The encryption method.', 'type' => 'string', 'required' => false, 'example' => 'plain', 'title' => ''], + 'UserName' => ['description' => 'The username.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + 'Password' => ['description' => 'The password for encryption.', 'type' => 'string', 'required' => false, 'example' => '***', 'title' => ''], 'Brokers' => [ - 'description' => 'The brokers.'."\n", + 'description' => 'The array of servers.', 'type' => 'array', - 'items' => [ - 'description' => 'The Kafka brokers.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.xxx.xxx:9902', - 'title' => '', - ], + 'items' => ['description' => 'The list of Kafka broker servers.', 'type' => 'string', 'required' => false, 'example' => '192.168.xxx.xxx:9902', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], - 'Compress' => [ - 'description' => 'The compression method.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'lz4', - 'title' => '', - ], - 'Balancer' => [ - 'description' => 'The load balancing method.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'kafka.LeastBytes', - 'title' => '', - ], + 'Compress' => ['description' => 'The compression method.', 'type' => 'string', 'required' => false, 'example' => 'lz4', 'title' => ''], + 'Balancer' => ['description' => 'The load balancing method.', 'type' => 'string', 'required' => false, 'example' => 'kafka.LeastBytes', 'title' => ''], ], 'required' => false, 'title' => '', @@ -19093,30 +9500,12 @@ 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The configurations for delivery to SLS.'."\n", + 'description' => 'The parameters for delivering logs to Log Service.', 'type' => 'object', 'properties' => [ - 'SLSRegion' => [ - 'description' => 'The region in which the SLS project resides.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - 'title' => '', - ], - 'SLSProject' => [ - 'description' => 'The name of the SLS project.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dcdn-test20240417', - 'title' => '', - ], - 'SLSLogStore' => [ - 'description' => 'The name of the Logstore.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'accesslog-test', - 'title' => '', - ], + 'SLSRegion' => ['description' => 'The region of the Log Service project.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + 'SLSProject' => ['description' => 'The name of the Log Service project.', 'type' => 'string', 'required' => false, 'example' => 'dcdn-test20240417', 'title' => ''], + 'SLSLogStore' => ['description' => 'The name of the Logstore in Log Service.', 'type' => 'string', 'required' => false, 'example' => 'accesslog-test', 'title' => ''], ], 'required' => false, 'title' => '', @@ -19126,50 +9515,24 @@ [ 'name' => 'FilterVer', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9358E852-992D-5BC7-8BD7-975CA02773A8', - ], - 'TaskName' => [ - 'description' => 'The name of the delivery task.'."\n", - 'type' => 'string', - 'example' => 'er-oss', - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'The website ID.[](~~2850189~~)'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456****', - 'title' => '', - ], - 'DataCenter' => [ - 'description' => 'The data center. Valid values:'."\n" - ."\n" - .'* cn: the Chinese mainland.'."\n" - .'* oversea: outside the Chinese mainland.'."\n", - 'type' => 'string', - 'example' => 'cn', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '9358E852-992D-5BC7-8BD7-975CA02773A8'], + 'TaskName' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => 'er-oss', 'title' => ''], + 'SiteId' => ['description' => 'Call the [ListSites](~~2850189~~) API to obtain this ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456****', 'title' => ''], + 'DataCenter' => ['description' => 'The data center. Valid values:'."\n" + ."\n" + .'- **cn**: Chinese mainland.'."\n" + ."\n" + .'- **Overseas**: regions outside the Chinese mainland.', 'type' => 'string', 'example' => 'cn', 'title' => ''], ], 'example' => '', ], @@ -19177,105 +9540,49 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'RealTimeLog.ProjectExistError', - 'errorMessage' => 'The real-time log delivery task name already exists. Check the task name and try again.', - 'description' => 'The real-time log delivery task name already exists. Check the task name and try again.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'RealTimeLog.ProjectExistError', 'errorMessage' => 'The real-time log delivery task name already exists. Check the task name and try again.', 'description' => 'The real-time log delivery task name already exists. Check the task name and try again.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], ], 403 => [ - [ - 'errorCode' => 'RealTimeLog.KafkaBrokersExceedError', - 'errorMessage' => 'The number of Kafka Broker addresses for real-time log delivery has reached the upper limit (50).', - 'description' => 'The number of Kafka Broker addresses for real-time log delivery has reached the upper limit (50).', - ], - [ - 'errorCode' => 'RealTimeLog.S3EndpointInvalidError', - 'errorMessage' => 'Invalid S3 information for the delivery task. Check your configurations and try again.', - 'description' => 'Invalid S3 information for the delivery task. Check your configurations and try again.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'EsaService.NotOpen', - 'errorMessage' => 'ESA service has not opend.', - 'description' => 'Edge Security Accelerator (ESA) is not turned on', - ], + ['errorCode' => 'RealTimeLog.KafkaBrokersExceedError', 'errorMessage' => 'The number of Kafka Broker addresses for real-time log delivery has reached the upper limit (50).', 'description' => 'The number of Kafka Broker addresses for real-time log delivery has reached the upper limit (50).'], + ['errorCode' => 'RealTimeLog.S3EndpointInvalidError', 'errorMessage' => 'Invalid S3 information for the delivery task. Check your configurations and try again.', 'description' => 'Invalid S3 information for the delivery task. Check your configurations and try again.'], + ['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' => '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.'], + ['errorCode' => 'EsaService.NotOpen', 'errorMessage' => 'ESA service has not opend.', 'description' => 'Edge Security Accelerator (ESA) is not turned on'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9358E852-992D-5BC7-8BD7-975CA02773A8\\",\\n \\"TaskName\\": \\"er-oss\\",\\n \\"SiteId\\": 0,\\n \\"DataCenter\\": \\"cn\\"\\n}","type":"json"}]', 'title' => 'CreateSiteDeliveryTask', 'changeSet' => [ - [ - 'createdAt' => '2025-06-24T01:43:11.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2025-02-28T07:44:20.000Z', - 'description' => 'Response parameters changed', - ], - [ - 'createdAt' => '2024-10-18T01:07:12.000Z', - 'description' => 'Error codes changed, Request parameters changed', - ], - [ - 'createdAt' => '2024-09-27T05:57:03.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-24T08:31:52.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-06-24T01:43:11.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-28T07:44:20.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-10-18T01:07:12.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2024-09-27T05:57:03.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-24T08:31:52.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateSiteDeliveryTask', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSiteDeliveryTask'], ], ], 'ramActions' => [ [ - 'operationType' => 'none', + 'operationType' => 'create', 'ramAction' => [ 'action' => 'esa:CreateSiteDeliveryTask', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], ], 'CreateTransportLayerApplication' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Creates a Layer 4 acceleration application.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -19288,131 +9595,82 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '245117', - 'abilityTreeNodes' => [ - 'FEATUREdcdnVFT29S', - ], + 'abilityTreeNodes' => ['FEATUREdcdnVFT29S'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID. The site must be activated.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'RecordName', 'in' => 'query', - 'schema' => [ - 'description' => 'Domain name of the transport layer application.', - 'type' => 'string', - 'required' => true, - 'example' => 'aaa.example.com', - 'title' => '', - ], + 'schema' => ['description' => 'The domain name of the Layer 4 application.', 'type' => 'string', 'required' => true, 'example' => 'aaa.example.com', 'title' => ''], ], [ 'name' => 'Rules', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'List of forwarding rules.', + 'description' => 'The list of forwarding rules.', 'type' => 'array', 'items' => [ - 'description' => 'Details of the rule. For each rule, except for the comment, all other parameters are required.', + 'description' => 'The rule details. For each rule, all parameters except the comment are required.', 'type' => 'object', 'properties' => [ 'Protocol' => [ - 'description' => 'Forwarding rule protocol, with values:'."\n" + 'description' => 'The forwarding rule protocol. Valid values:'."\n" ."\n" .'- TCP: TCP protocol.'."\n" .'- UDP: UDP protocol.', + 'enumValueTitles' => ['TCP' => 'TCP 协议', 'UDP' => 'UDP 协议'], 'type' => 'string', 'required' => true, - 'enum' => [ - 'TCP', - 'UDP', - ], + 'enum' => ['TCP', 'UDP'], 'example' => 'TCP', 'title' => '', ], - 'EdgePort' => [ - 'description' => 'Edge port. Supports:'."\n" - ."\n" - .'- A single port, such as 80.'."\n" - .'- Port range, such as 81-85, representing ports 81, 82, 83, 84, and 85.'."\n" - .'- Combination of ports and port ranges, separated by commas, such as 80,81-85,90, representing ports 80, 81, 82, 83, 84, 85, and 90.'."\n" - ."\n" - .'Edge ports within a single rule and between multiple rules must not overlap.', - 'type' => 'string', - 'required' => true, - 'example' => '80', - 'title' => '', - ], + 'EdgePort' => ['description' => 'The edge port. The following formats are supported:'."\n" + ."\n" + .'- A single port, such as 80.'."\n" + .'- A port range, such as 81-85, which represents ports 81, 82, 83, 84, and 85.'."\n" + .'- A combination of ports and port ranges separated by commas, such as 80,81-85,90, which represents ports 80, 81, 82, 83, 84, 85, and 90.'."\n" + ."\n" + .'Edge ports within a single rule and across multiple rules must not overlap.', 'type' => 'string', 'required' => true, 'example' => '80', 'title' => ''], 'SourceType' => [ - 'description' => 'Origin type, supporting:'."\n" + 'description' => 'The origin type. Valid values:'."\n" .'- **ip**: IP address.'."\n" - .'- **domain**: Domain name.'."\n" - .'- **OP**: Origin pool.'."\n" - .'- **LB**: Load balancer.', + .'- **domain**: domain name.'."\n" + .'- **OP**: origin IPAM pool.'."\n" + .'- **LB**: load balancing.', + 'enumValueTitles' => ['OP' => '源地址池', 'LB' => '负载均衡器', 'ip' => 'IP', 'domain' => '域名'], 'type' => 'string', 'required' => true, - 'enum' => [ - 'ip', - 'domain', - 'OP', - 'LB', - ], + 'enum' => ['ip', 'domain', 'OP', 'LB'], 'example' => 'ip', 'title' => '', ], - 'SourcePort' => [ - 'description' => 'Origin port. Supports:'."\n" - ."\n" - .'- A single port, when the origin port is a single port, any valid combination of edge ports is supported.'."\n" - .'- Port range, only when the edge port is a port range, the origin port can be set to a port range, and the size of the range must match that of the edge port. For example, if the edge port is 90-93, the origin port cannot be set to 81-85 because the origin port range is 5 and the edge port range is 3, which do not match.', - 'type' => 'string', - 'required' => true, - 'example' => '80', - 'title' => '', - ], + 'SourcePort' => ['description' => 'Origin Server Port. The following formats are supported:'."\n" + ."\n" + .'- A single port. When Origin Server Port is a single port, any valid edge port combination is supported.'."\n" + .'- A port range. Origin Server Port can be set to a port range only when the edge port is also a port range, and the range size must match the edge port range. For example, if the edge port is 90-93, you cannot set Origin Server Port to 81-85 because Origin Server Port range size is 5 while the edge port range size is 4, which is inconsistent.', 'type' => 'string', 'required' => true, 'example' => '80', 'title' => ''], 'ClientIPPassThroughMode' => [ - 'description' => 'Client IP pass-through protocol, supporting:'."\n" - .'- **off**: No pass-through.'."\n" - .'- **PPv1**: PROXY Protocol v1, supports client IP pass-through for TCP protocol.'."\n" - .'- **PPv2**: PROXY Protocol v2, supports client IP pass-through for TCP and UDP protocols.'."\n" - .'- **SPP**: Simple Proxy Protocol, supports client IP pass-through for UDP protocol.', + 'description' => 'The client IP pass-through protocol. Valid values:'."\n" + .'- **off**: disabled.'."\n" + .'- **PPv1**: PROXY Protocol v1. Supports client IP pass-through for TCP.'."\n" + .'- **PPv2**: PROXY Protocol v2. Supports client IP pass-through for TCP and UDP.'."\n" + .'- **SPP**: Simple Proxy Protocol. Supports client IP pass-through for UDP.', + 'enumValueTitles' => ['SPP' => 'Simple Proxy Protocol 协议', 'PPv2' => 'PROXY Protocol v2 协议', 'off' => '不传递', 'PPv1' => 'PROXY Protocol v1 协议'], 'type' => 'string', 'required' => true, - 'enum' => [ - 'off', - 'PPv2', - 'PPv1', - 'SPP', - ], + 'enum' => ['off', 'PPv2', 'PPv1', 'SPP'], 'example' => 'SPP', 'title' => '', ], - 'Source' => [ - 'description' => 'Specific value of the origin, which needs to match the origin type.', - 'type' => 'string', - 'required' => true, - 'example' => '1.1.1.1', - 'title' => '', - ], - 'Comment' => [ - 'description' => 'Comment information for the rule (optional).', - 'type' => 'string', - 'required' => false, - 'example' => '测试', - 'title' => '', - ], + 'Source' => ['description' => 'The specific value of the origin, which must match the origin type.', 'type' => 'string', 'required' => true, 'example' => '1.1.1.1', 'title' => ''], + 'Comment' => ['description' => 'The comment for the rule (optional).', 'type' => 'string', 'required' => false, 'example' => 'Test', 'title' => ''], ], 'required' => true, 'title' => '', @@ -19427,16 +9685,13 @@ 'name' => 'IpAccessRule', 'in' => 'query', 'schema' => [ - 'description' => 'IP access rule switch. When enabled, the WAF\'s IP access rules apply to the transport layer application.'."\n" + 'description' => 'The IP access rule switch. When enabled, IP access rules in WAF take effect for the Layer 4 application. Valid values:'."\n" ."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', + .'- on: enabled.'."\n" + .'- off: disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], 'example' => 'on', 'title' => '', ], @@ -19445,13 +9700,12 @@ 'name' => 'Ipv6', 'in' => 'query', 'schema' => [ - 'description' => 'IPv6 switch.', + 'description' => 'Specifies whether to enable IPv6. This feature is disabled by default. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], 'example' => 'off', 'title' => '', ], @@ -19460,15 +9714,12 @@ 'name' => 'CrossBorderOptimization', 'in' => 'query', 'schema' => [ - 'description' => 'Whether to enable China mainland network access optimization, default is disabled. Value range:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', + 'description' => 'Specifies whether to enable network access optimization for the Chinese mainland. This feature is disabled by default. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], 'example' => 'on', 'title' => '', ], @@ -19477,33 +9728,42 @@ 'name' => 'StaticIp', 'in' => 'query', 'schema' => [ + 'description' => 'Specifies whether to enable static IP. This feature is disabled by default. Valid values:'."\n" + ."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', 'required' => false, - 'description' => '', + 'example' => 'off', 'title' => '', - 'example' => '', + ], + ], + [ + 'name' => 'KeepAliveProtection', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Specifies whether to enable keep-alive protection. This feature is disabled by default. Valid values:'."\n" + ."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], + 'type' => 'string', + 'enum' => ['on', 'off'], + 'required' => false, + 'example' => 'off', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Request response details.', + 'description' => 'The response details.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '9e5448c7-edaf-49aa-9887-0fcd0832306c', - 'title' => '', - ], - 'ApplicationId' => [ - 'description' => 'Layer 4 application ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '165503967****', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9e5448c7-edaf-49aa-9887-0fcd0832306c', 'title' => ''], + 'ApplicationId' => ['description' => 'The Layer 4 application ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '165503967****', 'title' => ''], ], 'title' => '', 'example' => '', @@ -19512,149 +9772,63 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter.RecordData', - 'errorMessage' => 'Invalid record content. Adjust your configurations based on the API documentation.', - 'description' => 'Invalid record content. Adjust your configurations based on the API documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.RecordType', - 'errorMessage' => 'Invalid record type. Adjust your configurations based on the API documentation.', - 'description' => 'Invalid record type. Adjust your configurations based on the API documentation.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'QuotaExceed.RecordCount', - 'errorMessage' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.', - 'description' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.', - ], - [ - 'errorCode' => 'Record.Conflict', - 'errorMessage' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', - 'description' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', - ], - [ - 'errorCode' => 'Site.ServiceBusy', - 'errorMessage' => 'This website is being configured. Try again later.', - 'description' => 'This website is being configured. Try again later.', - ], - [ - 'errorCode' => 'TransportLayerRulesExceedLimit', - 'errorMessage' => 'The configured forwarding rules have exceeded the maximum limit. Delete useless forwarding rules and try again.', - 'description' => 'The configured forwarding rules have exceeded the maximum limit. Delete useless forwarding rules and try again.', - ], - [ - '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' => 'The Layer -4 accelerated application conflicts with other applications. Check whether the application name and host record conflict with other applications in the site.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'InvalidParameter.InvalidRecordName', - 'errorMessage' => 'The record name you entered does not meet the specifications. Change the record name according to the product documentation.', - 'description' => 'The record name you entered does not meet the specifications. Please adjust the record name according to the product documentation.', - ], - [ - 'errorCode' => 'EdgePortsOverlap', - 'errorMessage' => 'There is overlap between multiple edge ports, please check and try again after modification.', - 'description' => 'There is overlap between multiple edge ports, please check and try again after modification.', - ], - [ - 'errorCode' => 'InvalidParameter.ClientIpPassThroughMode', - 'errorMessage' => 'Invalid client IP transfer protocol, please refer to the interface document and pass in valid parameters.', - 'description' => 'Invalid client IP transfer protocol, please refer to the interface document and pass in valid parameters.', - ], - [ - 'errorCode' => 'InvalidParameter.RuleSource', - 'errorMessage' => 'The origin of the forwarding rule does not exist or is invalid. Enter the correct origin and try again.', - 'description' => 'The origin of the forwarding rule does not exist or is invalid. Enter the correct origin and try again.', - ], - [ - 'errorCode' => 'InvalidParameter.Port', - 'errorMessage' => 'Invalid edge port or origin port. Enter a valid port as required in the interface document.', - 'description' => 'Invalid edge port or origin port. Enter a valid port as required in the interface document.', - ], - [ - 'errorCode' => 'InvalidParameter.Protocol', - 'errorMessage' => 'Invalid port protocol. Enter a valid port protocol as required by the interface documentation.', - 'description' => 'Invalid port protocol. Enter a valid port protocol as required by the interface documentation.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], - [ - 'errorCode' => 'IpaResourceUnavailable', - 'errorMessage' => 'The resource is unavailable.', - 'description' => 'The resource is unavailable.', - ], - [ - 'errorCode' => 'Record.NoResource', - 'errorMessage' => 'Failed to allocate resources for the record. Please submit a ticket for processing.', - 'description' => 'Failed to allocate resources for the record. Please submit a work order for processing.', - ], - [ - 'errorCode' => 'InvalidParameter.PrivateIpAsSourceUnsupported', - 'errorMessage' => 'The provided source is an invalid private IP address. Please verify and resubmit.', - 'description' => 'The provided source is an invalid private IP address. Please verify and resubmit.', - ], - [ - 'errorCode' => 'InvalidParameter.SourceIpInBlacklist', - 'errorMessage' => 'The provided source is an invalid private IP address. Please verify and resubmit.', - 'description' => 'The provided source is an invalid private IP address. Please verify and resubmit.', - ], - [ - 'errorCode' => 'Site.NotActive', - 'errorMessage' => 'The status of the applied site or site is not activated.', - 'description' => 'The status of the applied site or site is not activated.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'Create Transport Layer Acceleration Application', - 'summary' => 'Create Transport Layer Application', + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.RecordData', 'errorMessage' => 'Invalid record content. Adjust your configurations based on the API documentation.', 'description' => 'Invalid record content. Adjust your configurations based on the API documentation.'], + ['errorCode' => 'InvalidParameter.RecordType', 'errorMessage' => 'Invalid record type. Adjust your configurations based on the API documentation.', 'description' => 'Invalid record type. Adjust your configurations based on the API documentation.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'QuotaExceed.RecordCount', 'errorMessage' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.', 'description' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.'], + ['errorCode' => 'Record.Conflict', 'errorMessage' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', 'description' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.'], + ['errorCode' => 'Site.ServiceBusy', 'errorMessage' => 'This website is being configured. Try again later.', 'description' => 'This website is being configured. Try again later.'], + ['errorCode' => 'TransportLayerRulesExceedLimit', 'errorMessage' => 'The configured forwarding rules have exceeded the maximum limit. Delete useless forwarding rules and try again.', 'description' => 'The configured forwarding rules have exceeded the maximum limit. Delete useless forwarding rules and try again.'], + ['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' => 'The Layer -4 accelerated application conflicts with other applications. Check whether the application name and host record conflict with other applications in the site.'], + ['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' => '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.'], + ['errorCode' => 'InvalidParameter.InvalidRecordName', 'errorMessage' => 'The record name you entered does not meet the specifications. Change the record name according to the product documentation.', 'description' => 'The record name you entered does not meet the specifications. Please adjust the record name according to the product documentation.'], + ['errorCode' => 'EdgePortsOverlap', 'errorMessage' => 'There is overlap between multiple edge ports, please check and try again after modification.', 'description' => 'There is overlap between multiple edge ports, please check and try again after modification.'], + ['errorCode' => 'InvalidParameter.ClientIpPassThroughMode', 'errorMessage' => 'Invalid client IP transfer protocol, please refer to the interface document and pass in valid parameters.', 'description' => 'Invalid client IP transfer protocol, please refer to the interface document and pass in valid parameters.'], + ['errorCode' => 'InvalidParameter.RuleSource', 'errorMessage' => 'The origin of the forwarding rule does not exist or is invalid. Enter the correct origin and try again.', 'description' => 'The origin of the forwarding rule does not exist or is invalid. Enter the correct origin and try again.'], + ['errorCode' => 'InvalidParameter.Port', 'errorMessage' => 'Invalid edge port or origin port. Enter a valid port as required in the interface document.', 'description' => 'Invalid edge port or origin port. Enter a valid port as required in the interface document.'], + ['errorCode' => 'InvalidParameter.Protocol', 'errorMessage' => 'Invalid port protocol. Enter a valid port protocol as required by the interface documentation.', 'description' => 'Invalid port protocol. Enter a valid port protocol as required by the interface documentation.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['errorCode' => 'IpaResourceUnavailable', 'errorMessage' => 'The resource is unavailable.', 'description' => 'The resource is unavailable.'], + ['errorCode' => 'Record.NoResource', 'errorMessage' => 'Failed to allocate resources for the record. Please submit a ticket for processing.', 'description' => 'Failed to allocate resources for the record. Please submit a work order for processing.'], + ['errorCode' => 'InvalidParameter.PrivateIpAsSourceUnsupported', 'errorMessage' => 'The provided source is an invalid private IP address. Please verify and resubmit.', 'description' => 'The provided source is an invalid private IP address. Please verify and resubmit.'], + ['errorCode' => 'InvalidParameter.SourceIpInBlacklist', 'errorMessage' => 'The provided source is an invalid private IP address. Please verify and resubmit.', 'description' => 'The provided source is an invalid private IP address. Please verify and resubmit.'], + ['errorCode' => 'Site.NotActive', 'errorMessage' => 'The status of the applied site or site is not activated.', 'description' => 'The status of the applied site or site is not activated.'], + ['errorCode' => 'IPA.KeepAliveProtectionConflict', 'errorMessage' => 'KeepAliveProtection is conflicted with StaticIp and CrossBorderOptimization, can not open at same time.', 'description' => 'KeepAliveProtection is conflicted with StaticIp and CrossBorderOptimization, can not open at same time'], + ['errorCode' => 'IPA.CanNotEnableKeepAliveProtection', 'errorMessage' => 'The site has one or more TCP/UDP proxied applications with keep-alive-protection enabled. Its acceleration region or plan can\'t be edited.', 'description' => 'DDoS protection for Chinese mainland or outside the Chinese mainland can\'t be "Basic protection"'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9e5448c7-edaf-49aa-9887-0fcd0832306c\\",\\n \\"ApplicationId\\": 0\\n}","type":"json"}]', + 'title' => 'Create a layer 4 acceleration application', + 'description' => 'The selected site must be activated. After you create a site, call the VerifySite operation to verify the site. A site that passes verification is automatically activated, which means the Passed response parameter is set to true.', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTransportLayerApplication'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:CreateTransportLayerApplication', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], + ], + ], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9e5448c7-edaf-49aa-9887-0fcd0832306c\\",\\n \\"ApplicationId\\": 0\\n}","type":"json"}]', ], 'CreateUrlObservation' => [ - 'summary' => 'Create a web page monitoring configuration.', + 'summary' => 'Creates a web monitoring configuration.', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -19667,28 +9841,19 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '264795', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456******', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456******', 'title' => ''], ], [ 'name' => 'Url', 'in' => 'query', 'schema' => [ - 'description' => 'The URL of the web page to monitor.'."\n", + 'description' => 'The URL of the web page to monitor. If the site name is example.com, set Url to example.com/test or site DNS record name/path.', 'type' => 'string', 'required' => true, 'enum' => [], @@ -19700,16 +9865,14 @@ 'name' => 'SdkType', 'in' => 'query', 'schema' => [ - 'description' => 'SDK integration. Supported'."\n" + 'description' => 'The SDK integration method. Valid values:'."\n" ."\n" - .'* **automatic**'."\n" - .'* **manual**'."\n", + .'- **automatic**: automatic integration.'."\n" + .'- **manual**: manual integration.', + 'enumValueTitles' => ['automatic' => 'Automatic integration.', 'manual' => 'Manual integration.'], 'type' => 'string', 'required' => true, - 'enum' => [ - 'manual', - 'automatic', - ], + 'enum' => ['manual', 'automatic'], 'example' => 'automatic', 'title' => '', ], @@ -19718,23 +9881,12 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n", - ], - 'ConfigId' => [ - 'description' => 'The configuration ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '35281609698****', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n"], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '35281609698****', 'title' => ''], ], 'example' => '', ], @@ -19742,169 +9894,47 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - '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' => '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.', - ], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['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' => '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.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\\\n\\",\\n \\"ConfigId\\": 0\\n}","type":"json"}]', - 'title' => 'CreateUrlObservation', + 'title' => 'Create a web monitoring configuration', 'changeSet' => [ - [ - 'createdAt' => '2025-08-18T03:46:41.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-08-18T03:46:41.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateUrlObservation', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUrlObservation'], ], ], 'ramActions' => [ @@ -19915,25 +9945,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], ], 'CreateUserDeliveryTask' => [ - 'summary' => 'Creates a log delivery task to ship logs to the specified destination.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Creates a custom log shipping task to SLS, HTTP, OSS, S3, or Kafka.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -19946,165 +9967,81 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238999', - 'abilityTreeNodes' => [ - 'FEATUREdcdn9K10I1', - ], + 'abilityTreeNodes' => ['FEATUREdcdn9K10I1'], ], 'parameters' => [ [ 'name' => 'BusinessType', 'in' => 'formData', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '', - 'description' => 'The log category. Valid values:'."\n" - ."\n" - .'* dcdn_log_access_l1 (default): access logs.'."\n" - .'* dcdn_log_er: Edge Routine logs.'."\n" - .'* dcdn_log_waf: firewall logs.'."\n" - .'* dcdn_log_ipa: TCP/UDP proxy logs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dcdn_log_access_l1', - ], + 'schema' => ['description' => 'The real-time log type. Valid values:'."\n" + ."\n" + .'- **dcdn\\_log\\_access\\_l1** (default): access log.'."\n" + ."\n" + .'- **dcdn\\_log\\_er**: edge function log.'."\n" + ."\n" + .'- **dcdn\\_log\\_waf**: WAF log.'."\n" + ."\n" + .'- **dcdn\\_log\\_ipa**: Layer-4 acceleration log.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'dcdn_log_access_l1'], ], [ 'name' => 'DataCenter', 'in' => 'formData', - 'schema' => [ - 'description' => 'The data center. Valid values:'."\n" - ."\n" - .'* cn: the Chinese mainland.'."\n" - .'* sg: outside the Chinese mainland.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn', - 'title' => '', - ], + 'schema' => ['description' => 'The data center. Valid values:'."\n" + ."\n" + .'- **cn**: Chinese mainland.'."\n" + ."\n" + .'- **sg**: global (excluding the Chinese mainland).', 'type' => 'string', 'required' => false, 'example' => 'cn', 'title' => ''], ], [ 'name' => 'TaskName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The task name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_project', - 'title' => '', - ], + 'schema' => ['description' => 'The task name.', 'type' => 'string', 'required' => true, 'example' => 'test_project', 'title' => ''], ], [ 'name' => 'FieldName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The log field. If you specify multiple fields, separate them with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'user_agent,ip_address,ip_port', - 'title' => '', - ], + 'schema' => ['description' => 'The fields to be delivered. Separate multiple fields with a comma.', 'type' => 'string', 'required' => true, 'example' => 'user_agent,ip_address,ip_port', 'title' => ''], ], [ 'name' => 'DeliveryType', 'in' => 'formData', - 'schema' => [ - 'description' => 'The destination of the delivery. Valid values:'."\n" - ."\n" - .'1. sls: Alibaba Cloud SLS.'."\n" - .'2. http: HTTP server.'."\n" - .'3. aws3: Amazon S3.'."\n" - .'4. oss: Alibaba Cloud OSS.'."\n" - .'5. kafka: Kafka.'."\n" - .'6. aws3cmpt: S3-compatible storage service.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'sls', - 'title' => '', - ], + 'schema' => ['description' => 'The log delivery destination. Valid values:'."\n" + ."\n" + .'- **sls**: Log Service (SLS).'."\n" + ."\n" + .'- **http**: an HTTP service.'."\n" + ."\n" + .'- **aws3**: Amazon S3.'."\n" + ."\n" + .'- **oss**: Object Storage Service (OSS).'."\n" + ."\n" + .'- **kafka**: Kafka.'."\n" + ."\n" + .'- **aws3cmpt**: an S3-compatible service.', 'type' => 'string', 'required' => true, 'example' => 'sls', 'title' => ''], ], [ 'name' => 'DiscardRate', 'in' => 'formData', - 'schema' => [ - 'description' => 'The discard rate. Default value: 0.'."\n", - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The log discard rate. Defaults to 0.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'S3Delivery', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The configurations for delivery to Amazon S3 or an S3-compatible service.'."\n", + 'description' => 'Configuration for delivering logs to Amazon S3 or an S3-compatible service.', 'type' => 'object', 'properties' => [ - 'Region' => [ - 'description' => 'The region ID of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai', - 'title' => '', - ], - 'BucketPath' => [ - 'description' => 'The directory in the bucket.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'logriver-test/log', - 'title' => '', - ], - 'AccessKey' => [ - 'description' => 'The access key ID of your Amazon S3 account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'g0f46623ll0g0', - 'title' => '', - ], - 'SecretKey' => [ - 'description' => 'The secret access key of your Amazon S3 account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '***', - 'title' => '', - ], - 'Endpoint' => [ - 'description' => 'The endpoint.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://s3.oss-cn-hangzhou.aliyuncs.com', - 'title' => '', - ], - 'PrefixPath' => [ - 'description' => 'The prefix of the path in which you want to store logs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'logriver-test/log', - 'title' => '', - ], - 'S3Cmpt' => [ - 'description' => 'Specifies whether the service is compatible with Amazon S3.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], - 'ServerSideEncryption' => [ - 'type' => 'boolean', - 'required' => false, - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'VertifyType' => [ - 'type' => 'string', - 'required' => false, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'Region' => ['description' => 'The destination region.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], + 'BucketPath' => ['description' => 'The bucket path.', 'type' => 'string', 'required' => false, 'example' => 'logriver-test/log', 'title' => ''], + 'AccessKey' => ['description' => 'The access key ID for the S3 account.', 'type' => 'string', 'required' => false, 'example' => 'g0f46623ll0g0', 'title' => ''], + 'SecretKey' => ['description' => 'The secret access key for the S3 account.', 'type' => 'string', 'required' => false, 'example' => '***', 'title' => ''], + 'Endpoint' => ['description' => 'The S3 endpoint.', 'type' => 'string', 'required' => false, 'example' => 'https://s3.oss-cn-hangzhou.aliyuncs.com', 'title' => ''], + 'PrefixPath' => ['description' => 'The object key prefix.', 'type' => 'string', 'required' => false, 'example' => 'logriver-test/log', 'title' => ''], + 'S3Cmpt' => ['description' => 'Specifies whether the destination is an S3-compatible service.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'ServerSideEncryption' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'VertifyType' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', @@ -20116,37 +10053,13 @@ 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The configurations for delivery to OSS.'."\n", + 'description' => 'Configuration for delivering logs to Object Storage Service (OSS).', 'type' => 'object', 'properties' => [ - 'Region' => [ - 'description' => 'The region in which the bucket is located.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - 'title' => '', - ], - 'Aliuid' => [ - 'description' => 'The ID of your Alibaba Cloud account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1234***', - 'title' => '', - ], - 'BucketName' => [ - 'description' => 'The name of the OSS bucket.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_rlog', - 'title' => '', - ], - 'PrefixPath' => [ - 'description' => 'The prefix of the path in which you want to store logs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test/', - 'title' => '', - ], + 'Region' => ['description' => 'The region of the destination OSS bucket.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + 'Aliuid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'required' => false, 'example' => '1234***', 'title' => ''], + 'BucketName' => ['description' => 'The bucket name.', 'type' => 'string', 'required' => false, 'example' => 'test_rlog', 'title' => ''], + 'PrefixPath' => ['description' => 'The object key prefix.', 'type' => 'string', 'required' => false, 'example' => 'test/', 'title' => ''], ], 'required' => false, 'title' => '', @@ -20158,130 +10071,41 @@ 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The configurations for delivery to an HTTP server.'."\n", + 'description' => 'Configuration for delivering logs to an HTTP or HTTPS endpoint.', 'type' => 'object', 'properties' => [ - 'DestUrl' => [ - 'description' => 'The address of the HTTP server.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://xxx.aliyun.com/v1/log/upload', - 'title' => '', - ], - 'StandardAuthOn' => [ - 'description' => 'Specifies whether to use server authentication.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], + 'DestUrl' => ['description' => 'The URL of the destination endpoint.', 'type' => 'string', 'required' => false, 'example' => 'http://xxx.aliyun.com/v1/log/upload', 'title' => ''], + 'StandardAuthOn' => ['description' => 'Specifies whether to enable standard authentication.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'StandardAuthParam' => [ - 'description' => 'The authentication configurations.'."\n", + 'description' => 'Configuration for standard authentication.', 'type' => 'object', 'properties' => [ - 'PrivateKey' => [ - 'description' => 'The private key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxxx', - 'title' => '', - ], - 'ExpiredTime' => [ - 'description' => 'The validity period of the signature.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '300', - 'title' => '', - ], - 'UrlPath' => [ - 'description' => 'The URL path.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'v1/log/upload', - 'title' => '', - ], + 'PrivateKey' => ['description' => 'The private key.', 'type' => 'string', 'required' => false, 'example' => 'xxxx', 'title' => ''], + 'ExpiredTime' => ['description' => 'The expiration time, in seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '300', 'title' => ''], + 'UrlPath' => ['description' => 'The URL path.', 'type' => 'string', 'required' => false, 'example' => 'v1/log/upload', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], - 'MaxBatchSize' => [ - 'description' => 'The maximum number of entries for each delivery.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000', - 'title' => '', - ], - 'MaxBatchMB' => [ - 'description' => 'The maximum size of data for each delivery. Unit: MB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5', - 'title' => '', - ], - 'MaxRetry' => [ - 'description' => 'The maximum number of retries.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3', - 'title' => '', - ], - 'TransformTimeout' => [ - 'description' => 'The timeout period. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - 'title' => '', - ], - 'LogBodyPrefix' => [ - 'description' => 'The prefix of the log delivery package.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cdnVersion:1.0', - 'title' => '', - ], - 'LogBodySuffix' => [ - 'description' => 'The suffix of the log delivery package.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cdnVersion:1.0', - 'title' => '', - ], - 'Compress' => [ - 'description' => 'The compression method.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gzip', - 'title' => '', - ], - 'LogSplitWords' => [ - 'description' => 'The log separator.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '\\n', - 'title' => '', - ], + 'MaxBatchSize' => ['description' => 'The maximum number of log entries per delivery request.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', 'title' => ''], + 'MaxBatchMB' => ['description' => 'The maximum size of a delivery batch, in MB.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', 'title' => ''], + 'MaxRetry' => ['description' => 'The maximum number of retries if a delivery fails.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'title' => ''], + 'TransformTimeout' => ['description' => 'The delivery timeout, in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + 'LogBodyPrefix' => ['description' => 'The prefix to add to the log delivery payload.', 'type' => 'string', 'required' => false, 'example' => 'cdnVersion:1.0', 'title' => ''], + 'LogBodySuffix' => ['description' => 'The suffix to add to the log delivery payload.', 'type' => 'string', 'required' => false, 'example' => 'cdnVersion:1.0', 'title' => ''], + 'Compress' => ['description' => 'The compression method.', 'type' => 'string', 'required' => false, 'example' => 'gzip', 'title' => ''], + 'LogSplitWords' => ['description' => 'The delimiter for log entries.', 'type' => 'string', 'required' => false, 'example' => '\\n', 'title' => ''], 'HeaderParam' => [ - 'description' => 'The custom headers.'."\n", + 'description' => 'Custom HTTP headers.', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'object', 'properties' => [ - 'StaticValue' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'aliyun', - 'description' => 'The value of the custom header.'."\n", - 'title' => '', - ], + 'StaticValue' => ['description' => 'The custom header value.', 'type' => 'string', 'required' => false, 'example' => 'aliyun', 'title' => ''], ], - 'description' => 'The name of the custom header.'."\n", + 'description' => 'The custom header name.', 'title' => '', 'example' => '', ], @@ -20289,41 +10113,23 @@ 'example' => '', ], 'QueryParam' => [ - 'description' => 'The custom query parameters.'."\n", + 'description' => 'Custom query parameters.', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'object', 'properties' => [ - 'StaticValue' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The value of the custom query parameter.'."\n", - 'example' => 'v1.1', - 'title' => '', - ], + 'StaticValue' => ['description' => 'The custom query parameter value.', 'type' => 'string', 'required' => false, 'example' => 'v1.1', 'title' => ''], ], - 'description' => 'The name of the custom query parameter.'."\n", + 'description' => 'The custom query parameter name.', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], - 'LogSplit' => [ - 'description' => 'Specifies whether to enable log splitting. Default value: true.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], - 'LastLogSplit' => [ - 'description' => 'The ending separator.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => '\\n', - 'title' => '', - ], + 'LogSplit' => ['description' => 'Specifies whether to split log entries. Defaults to true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'LastLogSplit' => ['description' => 'The trailing delimiter.', 'type' => 'boolean', 'required' => false, 'example' => '\\n', 'title' => ''], ], 'required' => false, 'title' => '', @@ -20335,72 +10141,24 @@ 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The configurations for delivery to Kafka.'."\n", + 'description' => 'Configuration for delivering logs to Kafka.', 'type' => 'object', 'properties' => [ - 'Topic' => [ - 'description' => 'The topic.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dqc_test2', - 'title' => '', - ], - 'UserAuth' => [ - 'description' => 'Specifies whether to enable authentication.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], - 'MachanismType' => [ - 'description' => 'The encryption method.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'plain', - 'title' => '', - ], - 'UserName' => [ - 'description' => 'The username.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - 'title' => '', - ], - 'Password' => [ - 'description' => 'The password.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - 'title' => '', - ], + 'Topic' => ['description' => 'The Kafka topic.', 'type' => 'string', 'required' => false, 'example' => 'dqc_test2', 'title' => ''], + 'UserAuth' => ['description' => 'Specifies whether to enable user authentication.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'MachanismType' => ['description' => 'The authentication mechanism.', 'type' => 'string', 'required' => false, 'example' => 'plain', 'title' => ''], + 'UserName' => ['description' => 'The username for authentication.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + 'Password' => ['description' => 'The password for authentication.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], 'Brokers' => [ - 'description' => 'The brokers.'."\n", + 'description' => 'A list of Kafka brokers.', 'type' => 'array', - 'items' => [ - 'description' => 'The Kafka brokers.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.0.1:9902', - 'title' => '', - ], + 'items' => ['description' => 'A Kafka broker, in the format `host:port`.', 'type' => 'string', 'required' => false, 'example' => '192.168.0.1:9902', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], - 'Compress' => [ - 'description' => 'The compression method. By default, data is not compressed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'lz4', - 'title' => '', - ], - 'Balancer' => [ - 'description' => 'The load balancing method.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'kafka.LeastBytes', - 'title' => '', - ], + 'Compress' => ['description' => 'The compression method. Disabled by default.', 'type' => 'string', 'required' => false, 'example' => 'lz4', 'title' => ''], + 'Balancer' => ['description' => 'The load balancing method.', 'type' => 'string', 'required' => false, 'example' => 'kafka.LeastBytes', 'title' => ''], ], 'required' => false, 'title' => '', @@ -20412,30 +10170,12 @@ 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The configurations for delivery to SLS.'."\n", + 'description' => 'Configuration for delivering logs to Log Service (SLS).', 'type' => 'object', 'properties' => [ - 'SLSRegion' => [ - 'description' => 'The region in which the SLS project resides.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - 'title' => '', - ], - 'SLSProject' => [ - 'description' => 'The name of the SLS project.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dcdn-test20240417', - 'title' => '', - ], - 'SLSLogStore' => [ - 'description' => 'The name of the SLS Logstore.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'accesslog-test', - 'title' => '', - ], + 'SLSRegion' => ['description' => 'The region of the destination project.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + 'SLSProject' => ['description' => 'The name of the destination project.', 'type' => 'string', 'required' => false, 'example' => 'dcdn-test20240417', 'title' => ''], + 'SLSLogStore' => ['description' => 'The name of the destination logstore.', 'type' => 'string', 'required' => false, 'example' => 'accesslog-test', 'title' => ''], ], 'required' => false, 'title' => '', @@ -20445,60 +10185,29 @@ [ 'name' => 'Details', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'FilterVer', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The data returned in the response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2CCD40B1-3F20-5FF0-8A67-E3F34B87744F', - ], - 'TaskName' => [ - 'description' => 'The name of the delivery task.'."\n", - 'type' => 'string', - 'example' => 'er-http', - 'title' => '', - ], - 'DataCenter' => [ - 'description' => 'The data center. Valid values:'."\n" - ."\n" - .'* cn: the Chinese mainland.'."\n" - .'* sg: outside the Chinese mainland.'."\n", - 'type' => 'string', - 'example' => 'cn', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the delivery task.'."\n", - 'type' => 'string', - 'example' => 'online', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'A unique identifier for the request.', 'type' => 'string', 'example' => '2CCD40B1-3F20-5FF0-8A67-E3F34B87744F'], + 'TaskName' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => 'er-http', 'title' => ''], + 'DataCenter' => ['description' => 'The data center. Valid values:'."\n" + ."\n" + .'- **cn**: Chinese mainland.'."\n" + ."\n" + .'- **sg**: Global (excluding Chinese mainland).', 'type' => 'string', 'example' => 'cn', 'title' => ''], + 'Status' => ['description' => 'The current status of the task.', 'type' => 'string', 'example' => 'online', 'title' => ''], ], 'example' => '', ], @@ -20506,92 +10215,46 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', - 'description' => 'Invalid parameter. Check the parameter configuration.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', 'description' => 'Invalid parameter. Check the parameter configuration.'], ], 403 => [ - [ - 'errorCode' => 'ErService.NotOpen', - 'errorMessage' => 'Er service has not opend.', - 'description' => 'Er service has not opend.', - ], - [ - 'errorCode' => 'RealTimeLog.S3EndpointInvalidError', - 'errorMessage' => 'Invalid S3 information for the delivery task. Check your configurations and try again.', - 'description' => 'Invalid S3 information for the delivery task. Check your configurations and try again.', - ], - [ - 'errorCode' => 'RealTimeLog.KafkaBrokersExceedError', - 'errorMessage' => 'The number of Kafka Broker addresses for real-time log delivery has reached the upper limit (50).', - 'description' => 'The number of Kafka Broker addresses for real-time log delivery has reached the upper limit (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' => '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.', - ], - [ - 'errorCode' => 'EsaService.NotOpen', - 'errorMessage' => 'ESA service has not opend.', - 'description' => 'Edge Security Accelerator (ESA) is not turned on', - ], + ['errorCode' => 'ErService.NotOpen', 'errorMessage' => 'Er service has not opend.', 'description' => 'Er service has not opend.'], + ['errorCode' => 'RealTimeLog.S3EndpointInvalidError', 'errorMessage' => 'Invalid S3 information for the delivery task. Check your configurations and try again.', 'description' => 'Invalid S3 information for the delivery task. Check your configurations and try again.'], + ['errorCode' => 'RealTimeLog.KafkaBrokersExceedError', 'errorMessage' => 'The number of Kafka Broker addresses for real-time log delivery has reached the upper limit (50).', 'description' => 'The number of Kafka Broker addresses for real-time log delivery has reached the upper limit (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' => '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.'], + ['errorCode' => 'EsaService.NotOpen', 'errorMessage' => 'ESA service has not opend.', 'description' => 'Edge Security Accelerator (ESA) is not turned on'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2CCD40B1-3F20-5FF0-8A67-E3F34B87744F\\",\\n \\"TaskName\\": \\"er-http\\",\\n \\"DataCenter\\": \\"cn\\",\\n \\"Status\\": \\"online\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateUserDeliveryTask', - 'description' => 'This API operation allows you to deliver logs to destinations such as Simple Log Service (SLS), HTTP servers, Object Storage Service (OSS), Amazon Simple Storage Service (S3), and Kafka. You can specify the task name, log fields to deliver, data center, discard rate, delivery type, and delivery details.'."\n" + 'description' => 'Use this API to create a delivery task for specific log data. It supports multiple delivery destinations, including SLS, HTTP services, Alibaba Cloud OSS, S3-compatible storage, and Kafka message queues. You can set a custom task name, select log fields, specify a data center, set the discard rate, choose a delivery type, and configure delivery details for the selected type.'."\n" + ."\n" + .'- **Field Filtering**: Use `FieldName` to specify the log fields to deliver.'."\n" + ."\n" + .'- **Filter Rules**: Use `FilterRules` to filter log data before delivery.'."\n" + ."\n" + .'- **Supported delivery destinations**: Deliver logs to various destinations, including SLS, HTTP(S), Alibaba Cloud OSS, S3-compatible storage, and Kafka. Each method has specific configuration parameters.'."\n" + ."\n" + .'## Notes'."\n" ."\n" - .'* **Field filtering**: Use the `FieldName` parameter to specify log fields to deliver.'."\n" - .'* **Filtering rules**: Use the `FilterRules` parameter to pre-process and filter log data.'."\n" - .'* **Diverse delivery destinations**: Logs can be delivered to different destinations. Configuration parameters vary with delivery destinations.'."\n" + .'- Ensure that your AccessKey and SecretKey have the required permissions for the delivery operation.'."\n" ."\n" - .'## [](#)Precautions'."\n" + .'- If a delivery method requires encryption or authentication, configure its security parameters accordingly.'."\n" ."\n" - .'* Make sure that you have sufficient permissions to perform delivery tasks.'."\n" - .'* If you enable encryption or authentication, properly configure corresponding parameters.'."\n" - .'* Verify the syntax of `FilterRules` to make sure that filtering logic works as expected.'."\n" - .'* Specify advanced settings such as the number of retries and timeout period based on your needs to have optimal delivery efficiency and stability.'."\n", + .'- Verify that the `FilterRules` syntax is correct.'."\n" + ."\n" + .'- Adjust advanced parameters, such as the number of retries and timeout, to optimize delivery efficiency and stability.', 'changeSet' => [ - [ - 'createdAt' => '2025-06-24T01:43:11.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-12-26T08:21:56.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-10-18T01:07:12.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-27T05:57:03.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-24T08:31:53.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-06-24T01:43:11.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-26T08:21:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-10-18T01:07:12.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-27T05:57:03.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-24T08:31:53.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateUserDeliveryTask', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUserDeliveryTask'], ], ], 'ramActions' => [ @@ -20602,44 +10265,27 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', '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' => 'Creates an instance-level Web Application Firewall (WAF) ruleset that supports various types of protection rules.', - 'description' => '## Request description'."\n" - ."\n" - .'- This API creates a new WAF ruleset for a specified instance.'."\n" - ."\n" - .'- The required `InstanceId` parameter specifies the instance for which to create the ruleset.'."\n" - ."\n" - .'- The `Phase` parameter defines the application phase of the ruleset, such as custom rules or rate limiting.'."\n" - ."\n" - .'- The required `Name` and `Expression` parameters specify the name of the ruleset and its match expression.'."\n" - ."\n" - .'- The optional `Description` parameter specifies a description for the ruleset.'."\n" - ."\n" - .'- The `Status` parameter controls whether the ruleset is active (`on`) or inactive (`off`).'."\n" - ."\n" - .'- The `Rules` parameter specifies a list of rules. Each rule includes properties such as a name, position, expression, and action.'."\n" - ."\n" - .'- A successful response returns the unique ID of the new ruleset in the `Id` parameter and a list of associated rule IDs in the `RuleIds` parameter.', + 'summary' => 'Creates an instance-level Web Application Firewall (WAF) ruleset that supports multiple types of protection rules.', + 'description' => '## Operation description'."\n" + .'- This API operation allows you to create a WAF ruleset for a specified instance.'."\n" + .'- InstanceId is a required parameter that specifies the instance for which you want to create the ruleset.'."\n" + .'- The Phase parameter defines the phase in which the ruleset is applied, such as custom rules or rate limiting.'."\n" + .'- Name and Expression are required parameters that specify the ruleset name and the match expression.'."\n" + .'- The optional Description parameter provides a text description of the ruleset function or purpose.'."\n" + .'- Status controls whether the ruleset takes effect immediately (`on`) or is disabled (`off`).'."\n" + .'- Use the Rules parameter to configure a detailed list of rules. Each rule contains properties such as name, position, expression, and action.'."\n" + .'- A successful response returns the unique identifier Id of the newly created ruleset and the RuleIds list of all associated rule IDs.', 'path' => '/', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -20651,108 +10297,79 @@ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdcdnV3YEJ8', - 'FEATUREdcdnUTRW1O', - 'FEATUREdcdnSU2QP6', - 'FEATUREdcdnV3G3FZ', - 'FEATUREdcdnBQ0J3E', - ], + 'abilityTreeNodes' => ['FEATUREdcdnV3YEJ8', 'FEATUREdcdnUTRW1O', 'FEATUREdcdnSU2QP6', 'FEATUREdcdnV3G3FZ', 'FEATUREdcdnBQ0J3E'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.', - 'type' => 'string', - 'required' => true, - 'example' => 'esa-site-ads11w', - 'title' => '', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'esa-site-ads11w', 'title' => ''], ], [ 'name' => 'Phase', 'in' => 'formData', - 'schema' => [ - 'description' => 'The execution phase of the WAF.', - 'type' => 'string', - 'required' => true, - 'example' => 'http_custom', - 'title' => '', - ], + 'schema' => ['description' => 'The phase to which the WAF ruleset belongs. Valid values:'."\n" + ."\n" + .'- http_whitelist: whitelist rules'."\n" + .'- http_custom: custom rules'."\n" + .'- http_managed: managed rules'."\n" + .'- http_anti_scan: scan protection rules'."\n" + .'- http_ratelimit: rate limiting rules'."\n" + ."\n" + .'> Note: The supported fields (Expression match fields, Action values, and others) vary by phase. For more information, refer to the rule configuration documentation for the corresponding phase.', 'type' => 'string', 'required' => true, 'example' => 'http_custom', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the WAF ruleset.', - 'type' => 'string', - 'required' => true, - 'example' => 'example', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the WAF ruleset.'."\n" + ."\n" + .'**Naming suggestion**: Use a combination of letters, digits, and underscores for easy reference. The specific character set, maximum length, and uniqueness constraints are subject to the WAF ruleset service naming conventions.', 'type' => 'string', 'required' => true, 'example' => 'example', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the WAF ruleset.', - 'type' => 'string', - 'required' => false, - 'example' => 'this is a test ruleset.', - 'title' => '', - ], + 'schema' => ['description' => 'The description of the WAF ruleset.', 'type' => 'string', 'required' => false, 'example' => 'this is a test ruleset.', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'formData', - 'schema' => [ - 'description' => 'The status of the WAF ruleset.', - 'type' => 'string', - 'required' => true, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'The status of the WAF ruleset. Valid values:'."\n" + ."\n" + .'- on: Enabled. The rules in the ruleset participate in matching and blocking.'."\n" + .'- off: Disabled. The ruleset is retained but does not participate in matching.'."\n" + ."\n" + .'> The complete set of valid values is subject to the server-side enum.', 'type' => 'string', 'required' => true, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Expression', 'in' => 'formData', - 'schema' => [ - 'description' => 'The expression for the WAF ruleset.', - 'type' => 'string', - 'required' => true, - 'example' => 'ip.src == 1.1.1.1', - 'title' => '', - ], + 'schema' => ['description' => 'The match expression of the WAF ruleset. Rules in this ruleset are evaluated only when a request matches this expression.'."\n" + ."\n" + .'Examples:'."\n" + .'- `http.host eq "example.com"` — Only requests with the host example.com enter this ruleset.'."\n" + .'- `starts_with(http.uri.path, "/api/")` — Only requests with the /api/ prefix enter this ruleset.'."\n" + ."\n" + .'> The complete expression syntax and available field set are subject to the server-side wirefilter dialect.', 'type' => 'string', 'required' => true, 'example' => 'ip.src == 1.1.1.1', 'title' => ''], ], [ 'name' => 'Shared', 'in' => 'formData', 'style' => 'json', - 'schema' => [ - 'description' => 'The shared configuration for WAF batch rules.', - '$ref' => '#/components/schemas/WafBatchRuleShared', - 'required' => false, - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The shared fields across multiple rules in this ruleset, such as a unified Action or Name prefix.'."\n" + ."\n" + .'> The field structure is subject to the `WafBatchRuleShared` data structure. If you do not need to share properties, you can leave this parameter empty.', '$ref' => '#/components/schemas/WafBatchRuleShared', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'Rules', 'in' => 'formData', 'style' => 'json', 'schema' => [ + 'description' => 'The list of rule configurations in the WAF ruleset. Each element corresponds to a rule.'."\n" + ."\n" + .'- The field structure of each rule is subject to the `WafRuleConfig` data structure, which includes Expression, Action, Name, and other fields.', 'type' => 'array', - 'items' => [ - 'description' => 'A rule configuration in the WAF ruleset.', - '$ref' => '#/components/schemas/WafRuleConfig', - 'required' => false, - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'The rule configuration in the WAF ruleset.', '$ref' => '#/components/schemas/WafRuleConfig', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, - 'description' => 'A list of rule configurations in the WAF ruleset.', 'title' => '', 'example' => '', ], @@ -20762,94 +10379,45 @@ 200 => [ 'description' => '创建成功', 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - 'title' => '', - ], - 'Id' => [ - 'description' => 'The ID of the WAF ruleset.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '665d3af3621bccf3fe29e1a4', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', 'title' => ''], + 'Id' => ['description' => 'The ID of the WAF ruleset.', 'type' => 'integer', 'format' => 'int64', 'example' => '665d3af3621bccf3fe29e1a4', 'title' => ''], 'RuleIds' => [ + 'description' => 'The list of rule IDs in the WAF ruleset.', 'type' => 'array', - 'items' => [ - 'description' => 'A rule ID in the WAF ruleset.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '87570', - 'title' => '', - ], - 'description' => 'A list of rule IDs in the WAF ruleset.', + 'items' => ['description' => 'The rule ID in the WAF ruleset.', 'type' => 'integer', 'format' => 'int64', 'example' => '87570', 'title' => ''], 'title' => '', 'example' => '', ], ], - 'title' => '', - 'description' => 'Schema of Response', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], 403 => [ - [ - 'errorCode' => 'Rule.Config.Noncompliance', - 'errorMessage' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', - 'description' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', - ], - [ - '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' => 'The format of the rule configuration is invalid.Check the configuration for syntax errors or structural inconsistencies and correct them to meet the requirements.', - ], - [ - 'errorCode' => '%s.NotSupport', - 'errorMessage' => 'The specified resource type %s is not supported.', - 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.', - ], - [ - 'errorCode' => '%s.OverQuota', - 'errorMessage' => 'The quantity of %s exceeds the quota.', - 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.', - ], - [ - 'errorCode' => '%s.WrongValueMatched', - 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', - 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.', - ], + ['errorCode' => 'Rule.Config.Noncompliance', 'errorMessage' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', 'description' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.'], + ['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' => 'The format of the rule configuration is invalid.Check the configuration for syntax errors or structural inconsistencies and correct them to meet the requirements.'], + ['errorCode' => '%s.NotSupport', 'errorMessage' => 'The specified resource type %s is not supported.', 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.'], + ['errorCode' => '%s.OverQuota', 'errorMessage' => 'The quantity of %s exceeds the quota.', 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.'], + ['errorCode' => '%s.WrongValueMatched', 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'CreateUserWafRuleset', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a WAF ruleset', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUserWafRuleset'], + ], ], 'ramActions' => [ [ @@ -20859,12 +10427,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -20872,13 +10435,9 @@ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"Id\\": 0,\\n \\"RuleIds\\": [\\n 87570\\n ]\\n}","type":"json"}]', ], 'CreateVideoProcessing' => [ - 'summary' => 'Add video processing configurations for a website.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Create a site video processing configuration.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -20891,60 +10450,35 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257663', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. The default value is version 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the scheduling rule. You do not need to set this parameter when you add global configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. You do not need to set this parameter when adding a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Specifies whether to check the image used by the instance supports hot migration. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", + 'description' => 'The rule switch. You do not need to set this parameter when adding a global configuration. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, - 'enum' => [ - 'on', - 'off', - ], 'example' => 'on', 'title' => '', ], @@ -20952,122 +10486,59 @@ [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:'."\n" - ."\n" - .'* true: Match all incoming requests.'."\n" - .'* Set the value to a custom expression, for example:(http.host eq "video.example.com"): Match the specified request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq \\"video.example.com\\")'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The rule content, which uses conditional expressions to match user requests. You do not need to set this parameter when adding a global configuration. Two usage scenarios are supported:'."\n" + .'- Match all incoming requests: set the value to true.'."\n" + .'- Match specified requests: set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', 'type' => 'string', 'required' => false, 'example' => '(http.host eq \\"video.example.com\\")'."\n", 'title' => ''], ], [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'The order in which the rule is executed. A smaller value gives priority to the rule.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'VideoSeekEnable', 'in' => 'query', - 'schema' => [ - 'description' => 'Video seeking. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'The video seek (drag-and-play) switch. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'FlvVideoSeekMode', 'in' => 'query', - 'schema' => [ - 'description' => 'FLV seeking. Valid values:'."\n" - ."\n" - .'* by_byte: seek by byte'."\n" - .'* by_time: seek by time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'by_byte', - 'title' => '', - ], + 'schema' => ['description' => 'The FLV seek mode. Valid values:'."\n" + .'- by_byte: seek by byte.'."\n" + .'- by_time: seek by time.', 'type' => 'string', 'required' => false, 'example' => 'by_byte', 'title' => ''], ], [ 'name' => 'Mp4SeekStart', 'in' => 'query', - 'schema' => [ - 'description' => 'Customize the mp4 start parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'start', - 'title' => '', - ], + 'schema' => ['description' => 'The custom MP4 start parameter.', 'type' => 'string', 'required' => false, 'example' => 'start', 'title' => ''], ], [ 'name' => 'Mp4SeekEnd', 'in' => 'query', - 'schema' => [ - 'description' => 'Customize the mp4 end parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'end', - 'title' => '', - ], + 'schema' => ['description' => 'The custom MP4 end parameter.', 'type' => 'string', 'required' => false, 'example' => 'end', 'title' => ''], ], [ 'name' => 'FlvSeekStart', 'in' => 'query', - 'schema' => [ - 'description' => 'The custom start parameter for FLV files.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'start', - 'title' => '', - ], + 'schema' => ['description' => 'The custom FLV start parameter.', 'type' => 'string', 'required' => false, 'example' => 'start', 'title' => ''], ], [ 'name' => 'FlvSeekEnd', 'in' => 'query', - 'schema' => [ - 'description' => 'Set custom end parameters for FLV files.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'end', - 'title' => '', - ], + 'schema' => ['description' => 'The custom FLV end parameter.', 'type' => 'string', 'required' => false, 'example' => 'end', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', - ], - 'ConfigId' => [ - 'description' => 'The configuration ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '352816**********', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE'], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '352816**********', 'title' => ''], ], 'example' => '', ], @@ -21075,155 +10546,45 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - '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' => '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.', - ], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['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' => '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.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\",\\n \\"ConfigId\\": 0\\n}","type":"json"}]', 'title' => 'CreateVideoProcessing', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateVideoProcessing'], + ], ], 'ramActions' => [ [ @@ -21233,26 +10594,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], ], 'CreateWafRule' => [ - 'summary' => 'Create WAF Rule', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Creates a rule in Web Application Firewall (WAF). You can use this operation to refine firewall behavior and improve the security of your website or application.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -21265,101 +10616,61 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239618', - 'abilityTreeNodes' => [ - 'FEATUREdcdnUTRW1O', - 'FEATUREdcdnSU2QP6', - 'FEATUREdcdnV3G3FZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdnUTRW1O', 'FEATUREdcdnSU2QP6', 'FEATUREdcdnV3G3FZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'title' => '站点ID', - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Site version.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version on which the configuration takes effect. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'Phase', 'in' => 'formData', - 'schema' => [ - 'title' => 'WAF阶段', - 'description' => 'WAF operation phase.', - 'type' => 'string', - 'required' => true, - 'example' => 'http_custom', - ], + 'schema' => ['title' => '', 'description' => 'The WAF rule execution phase. This **single-creation operation** supports the following phases (it does not support `http_anti_scan` or `http_bot`. For these two phases, use the batch operation `BatchCreateWafRules`):'."\n" + .'- `http_whitelist`: whitelist rule'."\n" + .'- `http_custom`: custom rule'."\n" + .'- `http_managed`: managed rule'."\n" + .'- `http_ratelimit`: rate limiting rule'."\n" + .'- `ip_access_rule`: IP access rule'."\n" + .'- `http_security_level_rule`: security rule'."\n" + ."\n" + .'> Note: `http_anti_scan` and `http_bot` can only be created through the batch operation. Passing these two values to this operation returns an error.', 'type' => 'string', 'required' => true, 'example' => 'http_custom'], ], [ 'name' => 'RulesetId', 'in' => 'formData', - 'schema' => [ - 'description' => 'Ruleset ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10000001', - 'minimum' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the WAF ruleset. You can call the [ListWafRulesets](~~2878359~~) operation to obtain the ruleset ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '1', 'example' => '10000001', 'title' => ''], ], [ 'name' => 'Config', 'in' => 'formData', 'style' => 'json', - 'schema' => [ - 'title' => 'WAF规则配置', - 'description' => 'Rule configuration, specifying the detailed configuration for creating a rule.', - 'required' => false, - '$ref' => '#/components/schemas/WafRuleConfig', - 'example' => '', - ], + 'schema' => ['title' => '', 'description' => 'The specific configuration of the WAF rule (`WafRuleConfig` data structure). The required fields vary depending on the Phase value:'."\n" + ."\n" + .'- `http_custom`: `Expression` (match expression) and `Action` (action upon match) are required. Setting `Name` is recommended for easier identification.'."\n" + .'- `http_whitelist`: `Expression` is required. Matched requests are allowed directly (no Action).'."\n" + .'- `http_ratelimit`: `Expression` and `RateLimit` (rate limiting parameters) are required.'."\n" + .'- `ip_access_rule`: `Expression` (containing IP match) and `Action` are required.'."\n" + ."\n" + .'> The complete field definitions are based on the `WafRuleConfig` data structure. If required fields are missing, the service returns `InvalidParameter(400)` / `Rule.Config.Malformed`.', '$ref' => '#/components/schemas/WafRuleConfig', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], - 'RulesetId' => [ - 'description' => 'ID of the WAF ruleset, which can be obtained by calling the [ListWafRulesets](~~2878359~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000001', - 'title' => '', - ], - 'Id' => [ - 'description' => 'The ID of the WAF rule, which can be obtained by calling the [ListWafRules](~~2878257~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20000001', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], + 'RulesetId' => ['description' => 'The ID of the WAF ruleset. You can call the [ListWafRulesets](~~2878359~~) operation to obtain the ruleset ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000001', 'title' => ''], + 'Id' => ['description' => 'The ID of the WAF rule. You can call the [ListWafRules](~~2878257~~) operation to obtain the rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '20000001', 'title' => ''], ], 'example' => '', ], @@ -21367,80 +10678,29 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], ], 403 => [ - [ - 'errorCode' => '%s.NotSupport', - 'errorMessage' => 'The specified resource type %s is not supported.', - 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.', - ], - [ - 'errorCode' => '%s.OverQuota', - 'errorMessage' => 'The quantity of %s exceeds the quota.', - 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.', - ], - [ - 'errorCode' => '%s.WrongValueMatched', - 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', - 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.', - ], - [ - 'errorCode' => 'Rule.Name.AlreadyExists', - 'errorMessage' => 'The specified rule name already exists.Try again with a unique name or modify the existing rule name.', - 'description' => 'The specified rule name already exists.Try again with a unique name or modify the existing rule name.', - ], - [ - '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' => 'The format of the rule configuration is invalid.Check the configuration for syntax errors or structural inconsistencies and correct them to meet the requirements.', - ], - [ - 'errorCode' => 'Rule.Config.Noncompliance', - 'errorMessage' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', - 'description' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', - ], - [ - 'errorCode' => 'Expression.Invalid', - 'errorMessage' => 'The specified expression is invalid: %s.', - 'description' => 'The specified expression is invalid.', - ], - [ - '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' => '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.', - ], + ['errorCode' => '%s.NotSupport', 'errorMessage' => 'The specified resource type %s is not supported.', 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.'], + ['errorCode' => '%s.OverQuota', 'errorMessage' => 'The quantity of %s exceeds the quota.', 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.'], + ['errorCode' => '%s.WrongValueMatched', 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.'], + ['errorCode' => 'Rule.Name.AlreadyExists', 'errorMessage' => 'The specified rule name already exists.Try again with a unique name or modify the existing rule name.', 'description' => 'The specified rule name already exists.Try again with a unique name or modify the existing rule name.'], + ['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' => 'The format of the rule configuration is invalid.Check the configuration for syntax errors or structural inconsistencies and correct them to meet the requirements.'], + ['errorCode' => 'Rule.Config.Noncompliance', 'errorMessage' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', 'description' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.'], + ['errorCode' => 'Expression.Invalid', 'errorMessage' => 'The specified expression is invalid: %s.', 'description' => 'The specified expression is invalid.'], + ['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' => '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.'], ], ], - 'title' => 'Create WAF Rule', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"RulesetId\\": 10000001,\\n \\"Id\\": 20000001\\n}","type":"json"}]', + 'title' => 'Create a WAF rule', 'changeSet' => [ - [ - 'createdAt' => '2024-09-25T07:02:52.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-25T07:02:52.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateWafRule', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWafRule'], ], ], 'ramActions' => [ @@ -21451,27 +10711,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => [ - 'summary' => 'Create WAF Ruleset', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Creates a WAF ruleset.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -21484,88 +10733,62 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '264021', - 'abilityTreeNodes' => [ - 'FEATUREdcdnUTRW1O', - 'FEATUREdcdnSU2QP6', - 'FEATUREdcdnV3G3FZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdnUTRW1O', 'FEATUREdcdnSU2QP6', 'FEATUREdcdnV3G3FZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'title' => '站点ID', - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '站点ID', 'description' => 'The site ID. To get this ID, call the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Site version.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The site configuration version. This parameter applies only if versioning is enabled for the site. The default is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'Phase', 'in' => 'formData', 'schema' => [ 'title' => 'WAF阶段', - 'description' => 'WAF operation phase.', + 'description' => 'The WAF rule execution phase. Valid values:'."\n" + ."\n" + .'- http\\_whitelist'."\n" + ."\n" + .'- http\\_custom'."\n" + ."\n" + .'- http\\_managed'."\n" + ."\n" + .'- http\\_anti\\_scan'."\n" + ."\n" + .'- http\\_ratelimit'."\n" + ."\n" + .'- ip\\_access\\_rule'."\n" + ."\n" + .'- http\\_bot'."\n" + ."\n" + .'- http\\_security\\_level\\_rule', + 'enumValueTitles' => ['http_whitelist' => 'whitelist rules', 'http_custom' => 'custom rules', 'http_managed' => 'managed rules', 'http_anti_scan' => 'scan protection rules', 'http_ratelimit' => 'rate limiting rules', 'http_bot' => 'bot management (professional mode)'], 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'http_whitelist' => 'whitelist rules', - 'http_custom' => 'custom rules', - 'http_managed' => 'managed rules', - 'http_anti_scan' => 'scan protection rules', - 'http_ratelimit' => 'rate limiting rules', - 'http_bot' => 'professional mode of bot management', - ], 'example' => 'http_custom', ], ], [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'Ruleset name.', - 'type' => 'string', - 'required' => false, - 'example' => 'example', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the WAF ruleset.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], - 'Id' => [ - 'description' => 'Ruleset ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000001', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], + 'Id' => ['description' => 'The ruleset ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000001', 'title' => ''], ], 'example' => '', ], @@ -21573,48 +10796,16 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], ], 403 => [ - [ - 'errorCode' => '%s.NotSupport', - 'errorMessage' => 'The specified resource type %s is not supported.', - 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.', - ], - [ - 'errorCode' => '%s.OverQuota', - 'errorMessage' => 'The quantity of %s exceeds the quota.', - 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.', - ], - [ - 'errorCode' => '%s.WrongValueMatched', - 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', - 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.', - ], - [ - 'errorCode' => 'Expression.Invalid', - 'errorMessage' => 'The specified expression is invalid: %s.', - 'description' => 'The specified expression is invalid.', - ], - [ - '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' => '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.', - ], + ['errorCode' => '%s.NotSupport', 'errorMessage' => 'The specified resource type %s is not supported.', 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.'], + ['errorCode' => '%s.OverQuota', 'errorMessage' => 'The quantity of %s exceeds the quota.', 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.'], + ['errorCode' => '%s.WrongValueMatched', 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.'], + ['errorCode' => 'Expression.Invalid', 'errorMessage' => 'The specified expression is invalid: %s.', 'description' => 'The specified expression is invalid.'], + ['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' => '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.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Id\\": 10000001\\n}","type":"json"}]', @@ -21622,12 +10813,7 @@ 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '20', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateWafRuleset', - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWafRuleset'], ], ], 'ramActions' => [ @@ -21638,12 +10824,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -21651,12 +10832,8 @@ ], 'CreateWaitingRoom' => [ 'summary' => 'Creates a waiting room for a website.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -21669,23 +10846,14 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239586', - 'abilityTreeNodes' => [ - 'FEATUREdcdnO4KC7Z', - ], + 'abilityTreeNodes' => ['FEATUREdcdnO4KC7Z'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'Enable', @@ -21693,44 +10861,34 @@ 'schema' => [ 'description' => 'Specifies whether to enable the waiting room. Valid values:'."\n" ."\n" - .'* on'."\n" - .'* off'."\n", + .'- **on**: Enabled.'."\n" + .'- **off**: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', 'required' => true, + 'enum' => ['on', 'off'], 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the waiting room.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'waitingroom_example'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The name of the waiting room.', 'type' => 'string', 'required' => true, 'example' => 'waitingroom_example'."\n", 'title' => ''], ], [ 'name' => 'QueueAllEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to queue all requests. Valid values:'."\n" + 'description' => 'Specifies whether to queue all visitors. Valid values:'."\n" ."\n" - .'* on'."\n" - .'* off'."\n", + .'- **on**: Enabled.'."\n" + .'- **off**: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], @@ -21739,33 +10897,15 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The hostname and path.'."\n", + 'description' => 'The hostname and path configurations.', 'type' => 'array', 'items' => [ - 'description' => 'The details of the hostname and path.'."\n", + 'description' => 'The hostname and path details.', 'type' => 'object', 'properties' => [ - 'Subdomain' => [ - 'description' => 'The subdomain.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test.', - 'title' => '', - ], - 'Domain' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'example.com', - 'title' => '', - ], - 'Path' => [ - 'description' => 'The path.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '/test', - 'title' => '', - ], + 'Subdomain' => ['description' => 'The subdomain.', 'type' => 'string', 'required' => true, 'example' => 'test.', 'title' => ''], + 'Domain' => ['description' => 'The domain name.', 'type' => 'string', 'required' => true, 'example' => 'example.com', 'title' => ''], + 'Path' => ['description' => 'The path.', 'type' => 'string', 'required' => true, 'example' => '/test', 'title' => ''], ], 'required' => true, 'title' => '', @@ -21779,46 +10919,22 @@ [ 'name' => 'CookieName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the custom cookie.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '__aliwaitingroom_example', - 'title' => '', - ], + 'schema' => ['description' => 'The custom cookie name.', 'type' => 'string', 'required' => true, 'example' => '__aliwaitingroom_example', 'title' => ''], ], [ 'name' => 'TotalActiveUsers', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of active users.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '300', - 'title' => '', - ], + 'schema' => ['description' => 'The total number of active users.', 'type' => 'string', 'required' => true, 'example' => '300', 'title' => ''], ], [ 'name' => 'NewUsersPerMinute', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of new users per minute.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '200', - 'title' => '', - ], + 'schema' => ['description' => 'The number of new users per minute.', 'type' => 'string', 'required' => true, 'example' => '200', 'title' => ''], ], [ 'name' => 'SessionDuration', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum duration for which a session remains valid after a user leaves the origin. Unit: minutes.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '5', - 'title' => '', - ], + 'schema' => ['description' => 'The session duration, in minutes.', 'type' => 'string', 'required' => true, 'example' => '5', 'title' => ''], ], [ 'name' => 'DisableSessionRenewalEnable', @@ -21826,15 +10942,13 @@ 'schema' => [ 'description' => 'Specifies whether to disable session renewal. Valid values:'."\n" ."\n" - .'* on'."\n" - .'* off'."\n", + .'- **on**: Enabled.'."\n" + .'- **off**: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', 'required' => false, + 'enum' => ['on', 'off'], 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], @@ -21844,19 +10958,15 @@ 'schema' => [ 'description' => 'The queuing method. Valid values:'."\n" ."\n" - .'* random: Users gain access to the origin randomly, regardless of the arrival time.'."\n" - .'* fifo: Users gain access to the origin in order of arrival.'."\n" - .'* passthrough: Users pass through the waiting room and go straight to the origin.'."\n" - .'* reject-all: Users are blocked from reaching the origin.'."\n", + .'- **random**: Random.'."\n" + .'- **fifo**: First in, first out.'."\n" + .'- **passthrough**: Passthrough.'."\n" + .'- **reject-all**: Reject all.', + 'enumValueTitles' => ['random' => 'Random.', 'fifo' => 'First in, first out.', 'passthrough' => 'Passthrough.', 'reject-all' => 'Reject all.'], 'type' => 'string', 'required' => true, + 'enum' => ['fifo', 'random', 'passthrough', 'reject-all'], 'example' => 'fifo', - 'enum' => [ - 'fifo', - 'random', - 'passthrough', - 'reject-all', - ], 'title' => '', ], ], @@ -21864,19 +10974,16 @@ 'name' => 'QueuingStatusCode', 'in' => 'query', 'schema' => [ - 'description' => 'The HTTP status code to return while a user is in the queue. Valid values:'."\n" + 'description' => 'The waiting room status code. Valid values:'."\n" ."\n" - .'* 200'."\n" - .'* 202'."\n" - .'* 429'."\n", + .'- **200**'."\n" + .'- **202**'."\n" + .'- **429**.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, + 'enum' => ['200', '202', '429'], 'example' => '200', - 'enum' => [ - '200', - '202', - '429', - ], 'title' => '', ], ], @@ -21884,17 +10991,15 @@ 'name' => 'JsonResponseEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable JSON response. If you set this parameter to on, a JSON body is returned for requests to the waiting room with the header Accept: application/json. Valid values:'."\n" + 'description' => 'Specifies whether to enable JSON response. When enabled, requests with an Accept header containing "application/json" return JSON data. Valid values:'."\n" ."\n" - .'* on'."\n" - .'* off'."\n", + .'- **on**: Enabled.'."\n" + .'- **off**: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], @@ -21902,13 +11007,7 @@ 'name' => 'Description', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The description of the waiting room.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '测试', - 'title' => '', - ], + 'schema' => ['description' => 'The description of the waiting room.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'WaitingRoomType', @@ -21916,15 +11015,13 @@ 'schema' => [ 'description' => 'The type of the waiting room. Valid values:'."\n" ."\n" - .'* default'."\n" - .'* custom'."\n", + .'- **default**: Default type.'."\n" + .'- **custom**: Custom type.', + 'enumValueTitles' => ['default' => 'Default type.', 'custom' => 'Custom type.'], 'type' => 'string', 'required' => true, + 'enum' => ['default', 'custom'], 'example' => 'default', - 'enum' => [ - 'default', - 'custom', - ], 'title' => '', ], ], @@ -21932,32 +11029,22 @@ 'name' => 'CustomPageHtml', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The content of the custom waiting room page. You must specify this parameter if you set WaitingRoomType to custom. The content must be Base64-encoded.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SGVsbG8gd29ybGQ=', - 'title' => '', - ], + 'schema' => ['description' => 'The custom waiting room page content. This parameter is required when the waiting room type is set to custom. The content must use Base64 encoding.', 'type' => 'string', 'required' => false, 'example' => 'SGVsbG8gd29ybGQ=', 'title' => ''], ], [ 'name' => 'Language', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'The language of the waiting room page. You must specify this parameter if you set WaitingRoomType to default. Valid values:'."\n" - ."\n" - .'* enus: English.'."\n" - .'* zhcn: Simplified Chinese.'."\n" - .'* zhhk: Traditional Chinese.'."\n", + 'description' => 'The language of the waiting room page. This parameter is required when the waiting room type is set to default. Valid values:'."\n" + .'- **enus**: English.'."\n" + .'- **zhcn**: Simplified Chinese.'."\n" + .'- **zhhk**: Traditional Chinese.', + 'enumValueTitles' => ['zhcn' => 'Simplified Chinese.', 'enus' => 'English.', 'zhhk' => 'Traditional Chinese.'], 'type' => 'string', + 'enum' => ['enus', 'zhcn', 'zhhk'], 'required' => false, 'example' => 'enus', - 'enum' => [ - 'enus', - 'zhcn', - 'zhhk', - ], 'title' => '', ], ], @@ -21967,18 +11054,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '85H66C7B-671A-4297-9187-2C4477247A74', - 'title' => '', - ], - 'WaitingRoomId' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '85H66C7B-671A-4297-9187-2C4477247A74', 'title' => ''], + 'WaitingRoomId' => ['description' => 'The waiting room ID.', 'type' => 'string', 'example' => '8527e8405ac25bfb7fb7ca0d12b0ed83', 'title' => ''], ], 'description' => '', 'title' => '', @@ -21988,145 +11065,44 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"85H66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"WaitingRoomId\\": \\"\\"\\n}","type":"json"}]', - 'title' => 'CreateWaitingRoom', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"85H66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"WaitingRoomId\\": \\"8527e8405ac25bfb7fb7ca0d12b0ed83\\"\\n}","type":"json"}]', + 'title' => 'Create a waiting room', 'changeSet' => [ - [ - 'createdAt' => '2025-02-12T02:01:32.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-02-12T02:01:32.000Z', 'description' => 'Response parameters changed'], ], '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}', - ], - ], - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWaitingRoom'], ], ], + 'ramActions' => [], ], 'CreateWaitingRoomEvent' => [ - 'summary' => 'Creates a waiting room event.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Creates a waiting room event. You can specify the queuing method and type.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -22139,96 +11115,55 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239633', - 'abilityTreeNodes' => [ - 'FEATUREdcdnVCBH9N', - ], + 'abilityTreeNodes' => ['FEATUREdcdnVCBH9N'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'WaitingRoomId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the waiting room, which can be obtained by calling the [ListWaitingRooms](~~2850279~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '6a51d5bc6460887abd1291dc7d4db28b', - 'title' => '', - ], + 'schema' => ['description' => 'The waiting room ID. You can call the [ListWaitingRooms](~~2850279~~) operation to obtain the waiting room ID. The waiting room must belong to the site specified by SiteId.', 'type' => 'string', 'required' => false, 'example' => '6a51d5bc6460887abd1291dc7d4db28b', 'title' => ''], ], [ 'name' => 'Enable', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable the waiting room. Valid values:'."\n" + 'description' => 'The waiting room switch. Valid values:'."\n" ."\n" - .'* on'."\n" - .'* off'."\n", + .'- **on**: enabled.'."\n" + .'- **off**: disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', 'required' => true, + 'enum' => ['on', 'off'], 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the waiting room event.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'waitingroom_example', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the waiting room event.', 'type' => 'string', 'required' => true, 'example' => 'waitingroom_example', 'title' => ''], ], [ 'name' => 'TotalActiveUsers', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of active users.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '100', - 'title' => '', - ], + 'schema' => ['description' => 'The total number of active users.', 'type' => 'string', 'required' => true, 'example' => '100', 'title' => ''], ], [ 'name' => 'NewUsersPerMinute', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of new users per minute.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '10', - 'title' => '', - ], + 'schema' => ['description' => 'The number of new users per minute.', 'type' => 'string', 'required' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'SessionDuration', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum duration for which a session remains valid after a user leaves the origin. Unit: minutes.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '5', - 'title' => '', - ], + 'schema' => ['description' => 'The session duration, in minutes.', 'type' => 'string', 'required' => true, 'example' => '5', 'title' => ''], ], [ 'name' => 'DisableSessionRenewalEnable', @@ -22236,15 +11171,13 @@ 'schema' => [ 'description' => 'Specifies whether to disable session renewal. Valid values:'."\n" ."\n" - .'* on'."\n" - .'* off'."\n", + .'- **on**: enabled.'."\n" + .'- **off**: disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', 'required' => false, + 'enum' => ['on', 'off'], 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], @@ -22254,19 +11187,15 @@ 'schema' => [ 'description' => 'The queuing method. Valid values:'."\n" ."\n" - .'* random: Users gain access to the origin randomly, regardless of the arrival time.'."\n" - .'* fifo: Users gain access to the origin in order of arrival.'."\n" - .'* passthrough: Users pass through the waiting room and go straight to the origin.'."\n" - .'* reject-all: Users are blocked from reaching the origin.'."\n", + .'- **random**: random.'."\n" + .'- **fifo**: first-in, first-out.'."\n" + .'- **passthrough**: passthrough.'."\n" + .'- **reject-all**: reject all.', + 'enumValueTitles' => ['random' => 'Random.', 'fifo' => 'First-in, first-out.', 'passthrough' => 'Passthrough.', 'reject-all' => 'Reject all.'], 'type' => 'string', 'required' => true, + 'enum' => ['fifo', 'random', 'passthrough', 'reject-all'], 'example' => 'random', - 'enum' => [ - 'fifo', - 'random', - 'passthrough', - 'reject-all', - ], 'title' => '', ], ], @@ -22274,19 +11203,16 @@ 'name' => 'QueuingStatusCode', 'in' => 'query', 'schema' => [ - 'description' => 'The HTTP status code to return while a user is in the queue. Valid values:'."\n" + 'description' => 'The waiting room status code. Valid values:'."\n" ."\n" - .'* 200'."\n" - .'* 202'."\n" - .'* 429'."\n", + .'- **200**'."\n" + .'- **202**'."\n" + .'- **429**.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, + 'enum' => ['200', '202', '429'], 'example' => '202', - 'enum' => [ - '200', - '202', - '429', - ], 'title' => '', ], ], @@ -22294,17 +11220,15 @@ 'name' => 'JsonResponseEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable JSON response. If you set this parameter to on, a JSON body is returned for requests to the waiting room with the header Accept: application/json. Valid values:'."\n" + 'description' => 'Specifies whether to enable JSON response. When enabled, requests with an Accept header containing "application/json" return JSON data. Valid values:'."\n" ."\n" - .'* on'."\n" - .'* off'."\n", + .'- **on**: enabled.'."\n" + .'- **off**: disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], @@ -22312,13 +11236,7 @@ 'name' => 'Description', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The description of the waiting room.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '测试等候室', - 'title' => '', - ], + 'schema' => ['description' => 'The description of the waiting room.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'WaitingRoomType', @@ -22326,15 +11244,13 @@ 'schema' => [ 'description' => 'The type of the waiting room. Valid values:'."\n" ."\n" - .'* default'."\n" - .'* custom'."\n", + .'- **default**: default type.'."\n" + .'- **custom**: custom type.', + 'enumValueTitles' => ['default' => 'Default type.', 'custom' => 'Custom type.'], 'type' => 'string', 'required' => true, + 'enum' => ['default', 'custom'], 'example' => 'default', - 'enum' => [ - 'default', - 'custom', - ], 'title' => '', ], ], @@ -22342,51 +11258,31 @@ 'name' => 'CustomPageHtml', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The content of the custom waiting room page. You must specify this parameter if you set WaitingRoomType to custom. The content must be Base64-encoded.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SGVsbG8gd29ybGQ=', - 'title' => '', - ], + 'schema' => ['description' => 'The custom waiting room page content. This parameter is required when the waiting room type is set to custom. The content must use Base64 encoding.', 'type' => 'string', 'required' => false, 'example' => 'SGVsbG8gd29ybGQ=', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The start time of the event. This value is a UNIX timestamp.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1719763200', - 'title' => '', - ], + 'schema' => ['description' => 'The event start timestamp, such as 1705044735.', 'type' => 'string', 'required' => true, 'example' => '1719763200', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The end time of the event. This value is a UNIX timestamp.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1719849600', - 'title' => '', - ], + 'schema' => ['description' => 'The event end timestamp, such as 1705044735.', 'type' => 'string', 'required' => true, 'example' => '1719849600', 'title' => ''], ], [ 'name' => 'PreQueueEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable pre-queuing.'."\n" + 'description' => 'Specifies whether to enable pre-queuing. Valid values:'."\n" ."\n" - .'* on'."\n" - .'* off'."\n", + .'- **on**: enabled.'."\n" + .'- **off**: disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], @@ -22394,29 +11290,21 @@ 'name' => 'PreQueueStartTime', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The start time for pre-queuing.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1719763200', - 'title' => '', - ], + 'schema' => ['description' => 'The pre-queuing start timestamp, which must be at least 5 minutes earlier than the event start timestamp, such as 1705044735.', 'type' => 'string', 'required' => false, 'example' => '1719763200', 'title' => ''], ], [ 'name' => 'RandomPreQueueEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable random queuing.'."\n" + 'description' => 'Specifies whether to enable random pre-queuing. Valid values:'."\n" ."\n" - .'* on'."\n" - .'* off'."\n", + .'- **on**: enabled.'."\n" + .'- **off**: disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], @@ -22425,19 +11313,16 @@ 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'The language of the waiting room page. You must specify this parameter if you set WaitingRoomType to default. Valid values:'."\n" + 'description' => 'The language of the waiting room page. This parameter is required when the waiting room type is set to default. Valid values:'."\n" ."\n" - .'* enus: English.'."\n" - .'* zhcn: Simplified Chinese.'."\n" - .'* zhhk: Traditional Chinese.'."\n", + .'- **enus**: English.'."\n" + .'- **zhcn**: Simplified Chinese.'."\n" + .'- **zhhk**: Traditional Chinese.', + 'enumValueTitles' => ['zhcn' => 'Simplified Chinese.', 'enus' => 'English.', 'zhhk' => 'Traditional Chinese.'], 'type' => 'string', + 'enum' => ['enus', 'zhcn', 'zhhk'], 'required' => false, 'example' => 'zhcn', - 'enum' => [ - 'enus', - 'zhcn', - 'zhhk', - ], 'title' => '', ], ], @@ -22447,19 +11332,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A123425345', - 'title' => '', - ], - 'WaitingRoomEventId' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A123425345', 'title' => ''], + 'WaitingRoomEventId' => ['description' => 'The waiting room event ID. You can call the [ListWaitingRoomEvents](~~2850279~~) operation to obtain the waiting room event ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '433277746085888', 'title' => ''], ], 'description' => '', 'title' => '', @@ -22469,145 +11343,45 @@ ], '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A123425345\\",\\n \\"WaitingRoomEventId\\": 0\\n}","type":"json"}]', - 'title' => 'CreateWaitingRoomEvent', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A123425345\\",\\n \\"WaitingRoomEventId\\": 433277746085888\\n}","type":"json"}]', + 'title' => 'Create a waiting room event', + 'description' => 'Your site plan must be Advanced or higher to use this feature. The number of configurations for this feature cannot exceed the quota included in your site plan.', 'changeSet' => [ - [ - 'createdAt' => '2025-02-12T02:01:32.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-02-12T02:01:32.000Z', 'description' => 'Response parameters changed'], ], '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}', - ], - ], - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWaitingRoomEvent'], ], ], + 'ramActions' => [], ], 'CreateWaitingRoomRule' => [ - 'summary' => 'Create Waiting Room Rule', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Creates a waiting room bypass rule.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -22620,75 +11394,48 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239640', - 'abilityTreeNodes' => [ - 'FEATUREdcdnA885EB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnA885EB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'WaitingRoomId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the waiting room to bypass.', - 'type' => 'string', - 'required' => true, - 'example' => '25133f536f1b1f6b6091f6a92c614dd4', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the waiting room to bypass.', 'type' => 'string', 'required' => true, 'example' => '25133f536f1b1f6b6091f6a92c614dd4', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => true, - 'example' => 'waitingroom_example'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. This parameter is not required when you add a global configuration.', 'type' => 'string', 'required' => true, 'example' => 'waitingroom_example'."\n", 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', + 'description' => 'Specifies whether to enable the rule. This parameter is not required when you add a global configuration. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, + 'enum' => ['on', 'off'], 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq "video.example.com")', - 'type' => 'string', - 'required' => true, - 'example' => '(http.request.uri.path.file_name eq \\"jpg\\")', - 'title' => '', - ], + 'schema' => ['description' => 'The rule content. Use a conditional expression to match user requests. This parameter is not required when you add a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + .'- Match specified requests: Set the value to a custom expression, for example, (http.host eq \\"video.example.com\\").'."\n" + ."\n" + .'For the complete syntax of rule expressions, refer to https://www.alibabacloud.com/help/en/edge-security-acceleration/esa/user-guide/work-with-rules-engine/https://www.alibabacloud.com/help/edge-security-acceleration/esa/user-guide/work-with-rules-engine/', 'type' => 'string', 'required' => true, 'example' => '(http.request.uri.path.file_name eq \\"jpg\\")', 'title' => ''], ], ], 'responses' => [ @@ -22696,19 +11443,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', - 'title' => '', - ], - 'WaitingRoomRuleId' => [ - 'description' => 'Waiting room bypass rule ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '420072638347264', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', 'title' => ''], + 'WaitingRoomRuleId' => ['description' => 'The ID of the waiting room bypass rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '420072638347264', 'title' => ''], ], 'description' => '', 'title' => '', @@ -22718,116 +11454,37 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\",\\n \\"WaitingRoomRuleId\\": 420072638347264\\n}","type":"json"}]', - 'title' => 'Create Waiting Room Bypass Rule', + 'title' => 'Create a waiting room bypass rule', + 'description' => 'Your site plan must be Enterprise Edition or higher to use this feature, and the site plan must support this feature.', 'changeSet' => [ - [ - 'createdAt' => '2025-02-12T02:01:32.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-02-12T02:01:32.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'CreateWaitingRoomRule', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWaitingRoomRule'], ], ], 'ramActions' => [ @@ -22838,25 +11495,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], ], 'DeactivateVersionManagement' => [ - 'summary' => 'Disables version management for a website.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Disables the version management feature for a site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -22869,22 +11517,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238972', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890***', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890***', 'title' => ''], ], ], 'responses' => [ @@ -22892,12 +11531,7 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C', 'title' => ''], ], 'description' => '', 'title' => '', @@ -22907,38 +11541,23 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'Site.ServiceBusy', - 'errorMessage' => 'This website is being configured. Try again later.', - 'description' => 'This website is being configured. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Site.ServiceBusy', 'errorMessage' => 'This website is being configured. Try again later.', 'description' => 'This website is being configured. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C\\"\\n}","type":"json"}]', - 'title' => 'DeactivateVersionManagement', - 'description' => 'You can disable version management only when the default environment and version 0 exist.'."\n", + 'title' => 'Disable site version management', + 'description' => 'Version management must be enabled through the ActivateVersionManagement operation (the site VersionManagement status is true). Version management can be disabled only when only version 0 and the default environment exist.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeactivateVersionManagement', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeactivateVersionManagement'], ], ], 'ramActions' => [ @@ -22949,29 +11568,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], ], 'DeleteCacheRule' => [ 'summary' => 'Delete Cache Configuration', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -22983,34 +11589,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257616', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '3500241*********', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '3500241*********', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'ConfigId of the configuration, which can be obtained by calling the [ListCacheRules](~~2866985~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '3528160*********', - 'title' => '', - ], + 'schema' => ['description' => 'ConfigId of the configuration, which can be obtained by calling the [ListCacheRules](~~2866985~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '3528160*********', 'title' => ''], ], ], 'responses' => [ @@ -23020,12 +11610,7 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n", - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n"], ], 'example' => '', ], @@ -23033,39 +11618,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], ], 404 => [ - [ - 'errorCode' => 'ConfigNotFound', - 'errorMessage' => 'The specified configid does not exist.', - 'description' => '', - ], + ['errorCode' => 'ConfigNotFound', 'errorMessage' => 'The specified configid does not exist.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\\\n\\"\\n}","type":"json"}]', 'title' => 'Delete Site Cache Configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteCacheRule', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCacheRule'], ], ], 'ramActions' => [ @@ -23076,12 +11642,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -23090,12 +11651,8 @@ ], 'DeleteCertificate' => [ 'summary' => 'Deletes a certificate for a website.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -23108,33 +11665,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238835', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'babaded901474b9693acf530e0fb1d95', - 'title' => '', - ], + 'schema' => ['description' => 'The certificate ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'babaded901474b9693acf530e0fb1d95', 'title' => ''], ], ], 'responses' => [ @@ -23144,31 +11686,10 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567890123', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com ', - 'title' => '', - ], - 'Id' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'example' => 'babaded901474b9693acf530e0fb1d95', - 'title' => '', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F32C57AA-7BF8-49AE-A2CC-9F42390F5A19', - 'title' => '', - ], + 'SiteId' => ['description' => 'The website ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''], + 'SiteName' => ['description' => 'The website name.'."\n", 'type' => 'string', 'example' => 'example.com ', 'title' => ''], + 'Id' => ['description' => 'The certificate ID.'."\n", 'type' => 'string', 'example' => 'babaded901474b9693acf530e0fb1d95', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F32C57AA-7BF8-49AE-A2CC-9F42390F5A19', 'title' => ''], ], 'example' => '', ], @@ -23176,55 +11697,21 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Certificate.StatusError', - 'errorMessage' => 'The status of the certificate is invalid.', - 'description' => 'The specified certificate status is invalid.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'Id.MissingParameter', - 'errorMessage' => 'The parameter Id is required.', - 'description' => 'The required parameter Id is missing.', - ], + ['errorCode' => 'Certificate.StatusError', 'errorMessage' => 'The status of the certificate is invalid.', 'description' => 'The specified certificate status is invalid.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Id.MissingParameter', 'errorMessage' => 'The parameter Id is required.', 'description' => 'The required parameter Id is missing.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'Certificate.NotFound', - 'errorMessage' => 'The specified certificate does not exist.', - 'description' => 'The specified certificate does not exist.', - ], + ['errorCode' => 'Certificate.NotFound', 'errorMessage' => 'The specified certificate does not exist.', 'description' => 'The specified certificate does not exist.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], @@ -23234,12 +11721,7 @@ 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteCertificate', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCertificate'], ], ], 'ramActions' => [ @@ -23250,12 +11732,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -23263,12 +11740,8 @@ ], 'DeleteClientCaCertificate' => [ 'summary' => 'Deletes a client CA certificate.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -23281,33 +11754,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239205', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'baba39055622c008b90285a8838ed09a', - 'title' => '', - ], + 'schema' => ['description' => 'The certificate ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'baba39055622c008b90285a8838ed09a', 'title' => ''], ], ], 'responses' => [ @@ -23317,31 +11775,10 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567890123', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com'."\n", - 'title' => '', - ], - 'Id' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'example' => 'baba39055622c008b90285a8838ed09a', - 'title' => '', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', - 'title' => '', - ], + 'SiteId' => ['description' => 'The website ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''], + 'SiteName' => ['description' => 'The website name.'."\n", 'type' => 'string', 'example' => 'example.com'."\n", 'title' => ''], + 'Id' => ['description' => 'The certificate ID.'."\n", 'type' => 'string', 'example' => 'baba39055622c008b90285a8838ed09a', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', 'title' => ''], ], 'example' => '', ], @@ -23349,66 +11786,27 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Certificate.StatusError', - 'errorMessage' => 'The status of the certificate is invalid.', - 'description' => 'The specified certificate status is invalid.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'Id.MissingParameter', - 'errorMessage' => 'The parameter Id is required.', - 'description' => 'The required parameter Id is missing.', - ], + ['errorCode' => 'Certificate.StatusError', 'errorMessage' => 'The status of the certificate is invalid.', 'description' => 'The specified certificate status is invalid.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Id.MissingParameter', 'errorMessage' => 'The parameter Id is required.', 'description' => 'The required parameter Id is missing.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'Certificate.NotFound', - 'errorMessage' => 'The specified certificate does not exist.', - 'description' => 'The specified certificate does not exist.', - ], + ['errorCode' => 'Certificate.NotFound', 'errorMessage' => 'The specified certificate does not exist.', 'description' => 'The specified certificate does not exist.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 1234567890123,\\n \\"SiteName\\": \\"example.com\\\\n\\",\\n \\"Id\\": \\"baba39055622c008b90285a8838ed09a\\",\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\"\\n}","type":"json"}]', 'title' => 'DeleteClientCaCertificate', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteClientCaCertificate', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteClientCaCertificate'], ], ], 'ramActions' => [ @@ -23419,12 +11817,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -23436,12 +11829,8 @@ ], 'DeleteClientCertificate' => [ 'summary' => 'Deletes a revoked client certificate.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -23454,33 +11843,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238905', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'baba39055622c008b90285a8838ed09a', - 'title' => '', - ], + 'schema' => ['description' => 'The certificate ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'baba39055622c008b90285a8838ed09a', 'title' => ''], ], ], 'responses' => [ @@ -23490,31 +11864,10 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567890123', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com'."\n", - 'title' => '', - ], - 'Id' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'example' => 'baba39055622c008b90285a8838ed09a', - 'title' => '', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - 'title' => '', - ], + 'SiteId' => ['description' => 'The website ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''], + 'SiteName' => ['description' => 'The website name.'."\n", 'type' => 'string', 'example' => 'example.com'."\n", 'title' => ''], + 'Id' => ['description' => 'The certificate ID.'."\n", 'type' => 'string', 'example' => 'baba39055622c008b90285a8838ed09a', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', 'title' => ''], ], 'example' => '', ], @@ -23522,61 +11875,26 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Certificate.StatusError', - 'errorMessage' => 'The status of the certificate is invalid.', - 'description' => 'The specified certificate status is invalid.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'Id.MissingParameter', - 'errorMessage' => 'The parameter Id is required.', - 'description' => 'The required parameter Id is missing.', - ], + ['errorCode' => 'Certificate.StatusError', 'errorMessage' => 'The status of the certificate is invalid.', 'description' => 'The specified certificate status is invalid.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Id.MissingParameter', 'errorMessage' => 'The parameter Id is required.', 'description' => 'The required parameter Id is missing.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'Certificate.NotFound', - 'errorMessage' => 'The specified certificate does not exist.', - 'description' => 'The specified certificate does not exist.', - ], + ['errorCode' => 'Certificate.NotFound', 'errorMessage' => 'The specified certificate does not exist.', 'description' => 'The specified certificate does not exist.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 1234567890123,\\n \\"SiteName\\": \\"example.com\\\\n\\",\\n \\"Id\\": \\"baba39055622c008b90285a8838ed09a\\",\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', 'title' => 'DeleteClientCertificate', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteClientCertificate', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteClientCertificate'], ], ], 'ramActions' => [ @@ -23587,12 +11905,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -23604,12 +11917,8 @@ ], 'DeleteCompressionRule' => [ 'summary' => 'Delete compression rule', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -23621,34 +11930,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257667', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID. It can be obtained by calling the [ListCompressionRules](~~2867498~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'Configuration ID. It can be obtained by calling the [ListCompressionRules](~~2867498~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '35281609698****', 'title' => ''], ], ], 'responses' => [ @@ -23658,12 +11951,7 @@ 'description' => 'Request response result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229'], ], 'example' => '', ], @@ -23671,39 +11959,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], ], 404 => [ - [ - 'errorCode' => 'ConfigNotFound', - 'errorMessage' => 'The specified configid does not exist.', - 'description' => '', - ], + ['errorCode' => 'ConfigNotFound', 'errorMessage' => 'The specified configid does not exist.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F61CDR30-E83C-4FDA-BF73-9A94CDD44229\\"\\n}","type":"json"}]', 'title' => 'Delete Compression Rule Configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteCompressionRule', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCompressionRule'], ], ], 'ramActions' => [ @@ -23714,12 +11983,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -23727,12 +11991,8 @@ 'operationType' => 'write', ], 'DeleteCustomHostname' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -23745,22 +12005,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239584', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4DMKZ4', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4DMKZ4'], ], 'parameters' => [ [ 'name' => 'HostnameId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the custom hostname. To obtain this ID, call the [ListCustomHostnames](~~3018667~~) operation.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'title' => '', - 'example' => '1234567890123', - ], + 'schema' => ['description' => 'The ID of the custom hostname. To obtain this ID, call the [ListCustomHostnames](~~3018667~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1234567890123'], ], ], 'responses' => [ @@ -23768,12 +12019,7 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID generated by Alibaba Cloud for the request.', - 'type' => 'string', - 'title' => '', - 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792', - ], + 'RequestId' => ['description' => 'The unique ID generated by Alibaba Cloud for the request.', 'type' => 'string', 'title' => '', 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792'], ], 'description' => '', 'title' => '', @@ -23783,38 +12029,14 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'Record.ServiceBusy', - 'errorMessage' => 'The record is being configured. Try again later.', - 'description' => 'The record is being configured. Try again later.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['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' => '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.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'Record.ServiceBusy', 'errorMessage' => 'The record is being configured. Try again later.', 'description' => 'The record is being configured. Try again later.'], ], 404 => [ - [ - 'errorCode' => 'CustomHostname.NotFound', - 'errorMessage' => 'The custom hostname does not exist. Modify it and try again.', - 'description' => 'The custom hostname does not exist. Modify it and try again.', - ], + ['errorCode' => 'CustomHostname.NotFound', 'errorMessage' => 'The custom hostname does not exist. Modify it and try again.', 'description' => 'The custom hostname does not exist. Modify it and try again.'], ], ], 'eventInfo' => [ @@ -23827,17 +12049,25 @@ 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'esa:DeleteCustomHostname', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"156A6B-677B1A-4297B7-9187B7-2B44792\\"\\n}","type":"json"}]', ], 'DeleteCustomResponseCodeRule' => [ 'summary' => 'Deletes a custom response code configuration for a site.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -23850,34 +12080,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257650', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The site ID. Obtain this by calling ListSites.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '478016908379824', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. Obtain this by calling ListSites.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '478016908379824', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '434497172875264', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '434497172875264', 'title' => ''], ], ], 'responses' => [ @@ -23887,12 +12101,7 @@ 'description' => 'The request response result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E'], ], 'example' => '', ], @@ -23900,28 +12109,14 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], ], 404 => [ - [ - 'errorCode' => 'ConfigNotFound', - 'errorMessage' => 'The specified configid does not exist.', - 'description' => '', - ], + ['errorCode' => 'ConfigNotFound', 'errorMessage' => 'The specified configid does not exist.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteCustomResponseCodeRule', 'changeSet' => [], 'flowControl' => [ @@ -23935,12 +12130,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -23949,14 +12139,8 @@ ], 'DeleteCustomScenePolicy' => [ 'summary' => 'Deletes a scenario-specific custom policy.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -23969,23 +12153,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239258', - 'abilityTreeNodes' => [ - 'FEATUREdcdnL8HX1L', - ], + 'abilityTreeNodes' => ['FEATUREdcdnL8HX1L'], ], 'parameters' => [ [ 'name' => 'PolicyId', 'in' => 'query', - 'schema' => [ - 'description' => 'The policy ID, which can be obtained by calling the [DescribeCustomScenePolicies](~~2850508~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '1', - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The policy ID, which can be obtained by calling the [DescribeCustomScenePolicies](~~2850508~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -23995,19 +12169,8 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5CC228B4-7A67-4016-9C9F-4A4133494A91', - ], - 'PolicyId' => [ - 'description' => 'The policy ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5CC228B4-7A67-4016-9C9F-4A4133494A91'], + 'PolicyId' => ['description' => 'The policy ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'example' => '', ], @@ -24015,39 +12178,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'PolicyNotExist', - 'errorMessage' => 'The policy does not exist.', - 'description' => 'The policy does not exist. ', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'PolicyNotExist', 'errorMessage' => 'The policy does not exist.', 'description' => 'The policy does not exist. '], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CC228B4-7A67-4016-9C9F-4A4133494A91\\",\\n \\"PolicyId\\": 1\\n}","type":"json"}]', 'title' => 'DeleteCustomScenePolicy', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteCustomScenePolicy', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomScenePolicy'], ], ], 'ramActions' => [ @@ -24058,12 +12202,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -24074,13 +12213,9 @@ ], ], 'DeleteEdgeContainerApp' => [ - 'summary' => 'Deletes a containerized application.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Deletes an edge container application that is no longer needed by application ID.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -24093,42 +12228,26 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238431', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'app-1232321454***', - 'title' => '', - ], + 'schema' => ['description' => 'The application ID. You can call the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation to obtain the application ID. '."\n" + .'AppId is required. If this parameter is not specified, the API returns InvalidParameter.appid (400). You can obtain the value by calling ListEdgeContainerApps.'."\n" + .'The AppId value is in the format of the app- prefix followed by 18 or more digits (at least 20 characters in total). You can obtain the actual value from the AppId field in the ListEdgeContainerApps response..', 'type' => 'string', 'required' => false, 'example' => 'app-1232321454***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response paramaters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - ], - 'State' => [ - 'description' => 'Specifies whether the deletion is successful.'."\n", - 'type' => 'string', - 'example' => 'ok', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'], + 'State' => ['description' => 'The deletion status.', 'type' => 'string', 'example' => 'ok', 'title' => ''], ], 'example' => '', ], @@ -24136,58 +12255,27 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InvalidParameter.appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], 403 => [ - [ - 'errorCode' => 'Record.AlreadyExist', - 'errorMessage' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', - 'description' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', - ], + ['errorCode' => 'Record.AlreadyExist', 'errorMessage' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', 'description' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.'], ], [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"State\\": \\"ok\\"\\n}","type":"json"}]', - 'title' => 'DeleteEdgeContainerApp', + 'title' => 'Delete an edge container application', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteEdgeContainerApp', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEdgeContainerApp'], ], ], 'ramActions' => [ @@ -24198,12 +12286,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -24212,12 +12295,8 @@ 'DeleteEdgeContainerAppImageSecret' => [ 'summary' => 'Deletes the image secret for an edge containerized application.', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -24229,32 +12308,18 @@ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID. Call the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation to obtain the application ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'app-88068867578379****', - 'title' => '', - ], + 'schema' => ['description' => 'The application ID. Call the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation to obtain the application ID.', 'type' => 'string', 'required' => true, 'example' => 'app-88068867578379****', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the image secret.', - 'type' => 'string', - 'required' => true, - 'example' => 'reg-123*****', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the image secret.', 'type' => 'string', 'required' => true, 'example' => 'reg-123*****', 'title' => ''], ], ], 'responses' => [ @@ -24264,12 +12329,7 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'], ], 'example' => '', ], @@ -24277,38 +12337,16 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', - 'description' => 'Invalid parameter. Check the parameter configuration.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], - [ - 'errorCode' => 'InvalidParameter.Appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the input application ID is incorrect. You can use the ListEdgeContainerApps API to obtain the application ID.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', 'description' => 'Invalid parameter. Check the parameter configuration.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['errorCode' => 'InvalidParameter.Appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the input application ID is incorrect. You can use the ListEdgeContainerApps API to obtain the application ID.'], ], 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteEdgeContainerAppImageSecret', 'changeSet' => [], 'flowControl' => [ @@ -24319,13 +12357,8 @@ ], 'DeleteEdgeContainerAppRecord' => [ 'summary' => 'Disassociates a domain name from a containerized application. After the dissociation, you can no longer use the domain name to access the containerized application.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -24337,47 +12370,23 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239235', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'app-88068867578379****', - 'maxLength' => 64, - 'minLength' => 20, - 'title' => '', - ], + 'schema' => ['description' => 'The application ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'app-88068867578379****', 'maxLength' => 64, 'minLength' => 20, 'title' => ''], ], [ 'name' => 'SiteId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5407498413****', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5407498413****', 'title' => ''], ], [ 'name' => 'RecordName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The associated domain name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a.example.com', - 'maxLength' => 1024, - 'title' => '', - ], + 'schema' => ['description' => 'The associated domain name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'a.example.com', 'maxLength' => 1024, 'title' => ''], ], ], 'responses' => [ @@ -24385,12 +12394,7 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', 'title' => ''], ], 'description' => '', 'title' => '', @@ -24400,30 +12404,14 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InvalidParameter.appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.'], ], 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', @@ -24431,12 +12419,7 @@ 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteEdgeContainerAppRecord', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEdgeContainerAppRecord'], ], ], 'ramActions' => [ @@ -24447,12 +12430,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -24464,12 +12442,8 @@ ], 'DeleteEdgeContainerAppVersion' => [ 'summary' => 'Deletes a version of a containerized application.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -24482,32 +12456,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238348', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'app-96253477062511****', - 'title' => '', - ], + 'schema' => ['description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'app-96253477062511****', 'title' => ''], ], [ 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the version that you want to delete. To obtain the version ID, call the [ListEdgeContainerAppVersions](~~ListEdgeContainerAppVersions~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ver-89884764010378****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the version that you want to delete. To obtain the version ID, call the [ListEdgeContainerAppVersions](~~ListEdgeContainerAppVersions~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ver-89884764010378****', 'title' => ''], ], ], 'responses' => [ @@ -24517,12 +12477,7 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'b021e538-9dde-46ed-a1f2-9469da8f3e77', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'b021e538-9dde-46ed-a1f2-9469da8f3e77'], ], 'example' => '', ], @@ -24530,40 +12485,18 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter.appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], @@ -24573,12 +12506,7 @@ 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteEdgeContainerAppVersion', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEdgeContainerAppVersion'], ], ], 'ramActions' => [ @@ -24589,12 +12517,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -24602,13 +12525,8 @@ ], 'DeleteHttpDDoSIntelligentRule' => [ 'summary' => 'Deletes a rule created by Deep Learning and Protection.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -24621,49 +12539,24 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '263721', - 'abilityTreeNodes' => [ - 'FEATUREdcdn5DYCZJ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn5DYCZJ'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the site. Call the [ListSites](~~ListSites~~) operation to obtain the site ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '1', - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the site. Call the [ListSites](~~ListSites~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '123456****', 'title' => ''], ], [ 'name' => 'RecordName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the record.', - 'type' => 'string', - 'required' => true, - 'minLength' => 1, - 'example' => 'www.example.com', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the record.', 'type' => 'string', 'required' => true, 'minLength' => 1, 'example' => 'www.example.com', 'title' => ''], ], [ 'name' => 'RuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the rule.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '1', - 'example' => '20928021', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the rule.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '20928021', 'title' => ''], ], ], 'responses' => [ @@ -24673,32 +12566,10 @@ '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' => 'The ID of the site. Call the [ListSites](~~2850189~~) operation to obtain the site ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456****', - 'title' => '', - ], - 'RecordName' => [ - 'description' => 'The name of the record.', - 'type' => 'string', - 'example' => 'www.example.com', - 'title' => '', - ], - 'RuleId' => [ - 'description' => 'The ID of the rule.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20757864', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74'], + 'SiteId' => ['description' => 'The ID of the site. Call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456****', 'title' => ''], + 'RecordName' => ['description' => 'The name of the record.', 'type' => 'string', 'example' => 'www.example.com', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '20757864', 'title' => ''], ], 'example' => '', ], @@ -24706,45 +12577,19 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'The specified SiteId is invalid.', - 'description' => 'The specified SiteId is invalid.Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'ErrSiteIdNoteEnterprise', - 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', - 'description' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', - ], - [ - 'errorCode' => 'InvalidParameter.ApiShieldSellVerison', - 'errorMessage' => 'The site does not have permissions to manipulate the enterprise-level capabilities of API security features.', - 'description' => 'The site does not have permissions to manipulate the enterprise-level capabilities of API security features.', - ], - [ - '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' => '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.', - ], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'The specified SiteId is invalid.', 'description' => 'The specified SiteId is invalid.Check parameter SiteId and try again.'], + ['errorCode' => 'ErrSiteIdNoteEnterprise', 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', 'description' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.'], + ['errorCode' => 'InvalidParameter.ApiShieldSellVerison', 'errorMessage' => 'The site does not have permissions to manipulate the enterprise-level capabilities of API security features.', 'description' => 'The site does not have permissions to manipulate the enterprise-level capabilities of API security features.'], + ['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' => '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.'], ], 403 => [ - [ - 'errorCode' => 'SiteIdDDoSVersionCheckFailed', - 'errorMessage' => 'SiteId DDoS version check failed.', - 'description' => 'Failed to check the DDoS version corresponding to the site.', - ], + ['errorCode' => 'SiteIdDDoSVersionCheckFailed', 'errorMessage' => 'SiteId DDoS version check failed.', 'description' => 'Failed to check the DDoS version corresponding to the site.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Delete rules for deep learning and protection distribution', 'changeSet' => [], 'flowControl' => [ @@ -24758,12 +12603,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -24772,12 +12612,8 @@ ], 'DeleteHttpIncomingRequestHeaderModificationRule' => [ 'summary' => 'Deletes the configuration of modifying incoming HTTP request headers for a website.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -24789,34 +12625,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257650', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '54362329990032', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '54362329990032', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration ID. You can call the ListHttpIncomingRequestHeaderModificationRules operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '427428371703808', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID. You can call the ListHttpIncomingRequestHeaderModificationRules operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '427428371703808', 'title' => ''], ], ], 'responses' => [ @@ -24826,12 +12646,7 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E'], ], 'example' => '', ], @@ -24839,28 +12654,14 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], ], 404 => [ - [ - 'errorCode' => 'ConfigNotFound', - 'errorMessage' => 'The specified configid does not exist.', - 'description' => '', - ], + ['errorCode' => 'ConfigNotFound', 'errorMessage' => 'The specified configid does not exist.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C370DAF1-C838-4288-A1A0-9A87633D248E\\"\\n}","type":"json"}]', 'title' => 'DeleteHttpIncomingRequestHeaderModificationRule', 'changeSet' => [], @@ -24875,12 +12676,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -24889,12 +12685,8 @@ ], 'DeleteHttpIncomingResponseHeaderModificationRule' => [ 'summary' => 'Deletes the configuration of modifying HTTP response headers for a website.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -24906,34 +12698,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257656', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '672344269424192', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '672344269424192', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration ID. You can call the ListHttpIncomingResponseHeaderModificationRules operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '352816096987136', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID. You can call the ListHttpIncomingResponseHeaderModificationRules operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '352816096987136', 'title' => ''], ], ], 'responses' => [ @@ -24943,12 +12719,7 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74'], ], 'example' => '', ], @@ -24956,28 +12727,14 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], ], 404 => [ - [ - 'errorCode' => 'ConfigNotFound', - 'errorMessage' => 'The specified configid does not exist.', - 'description' => '', - ], + ['errorCode' => 'ConfigNotFound', 'errorMessage' => 'The specified configid does not exist.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', 'title' => 'DeleteHttpIncomingResponseHeaderModificationRule', 'changeSet' => [], @@ -24992,12 +12749,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -25006,12 +12758,8 @@ ], 'DeleteHttpRequestHeaderModificationRule' => [ 'summary' => 'Deletes the configuration of modifying HTTP request headers for a website.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -25023,34 +12771,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257650', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration ID, which can be obtained by calling the [ListHttpRequestHeaderModificationRules](~~ListHttpRequestHeaderModificationRules~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '3528160969****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID, which can be obtained by calling the [ListHttpRequestHeaderModificationRules](~~ListHttpRequestHeaderModificationRules~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '3528160969****', 'title' => ''], ], ], 'responses' => [ @@ -25060,12 +12792,7 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '35C66C7B-671H-4297-9187-2C4477247A78', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '35C66C7B-671H-4297-9187-2C4477247A78'], ], 'example' => '', ], @@ -25073,39 +12800,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], ], 404 => [ - [ - 'errorCode' => 'ConfigNotFound', - 'errorMessage' => 'The specified configid does not exist.', - 'description' => '', - ], + ['errorCode' => 'ConfigNotFound', 'errorMessage' => 'The specified configid does not exist.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35C66C7B-671H-4297-9187-2C4477247A78\\"\\n}","type":"json"}]', 'title' => 'DeleteHttpRequestHeaderModificationRule', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteHttpRequestHeaderModificationRule', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHttpRequestHeaderModificationRule'], ], ], 'ramActions' => [ @@ -25116,12 +12824,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -25130,12 +12833,8 @@ ], 'DeleteHttpResponseHeaderModificationRule' => [ 'summary' => 'Deletes the configuration of modifying HTTP response headers for a website.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -25147,34 +12846,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257656', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration ID, which can be obtained by calling the [ListHttpResponseHeaderModificationRules](~~ListHttpResponseHeaderModificationRules~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID, which can be obtained by calling the [ListHttpResponseHeaderModificationRules](~~ListHttpResponseHeaderModificationRules~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '35281609698****', 'title' => ''], ], ], 'responses' => [ @@ -25184,12 +12867,7 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229'], ], 'example' => '', ], @@ -25197,39 +12875,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], ], 404 => [ - [ - 'errorCode' => 'ConfigNotFound', - 'errorMessage' => 'The specified configid does not exist.', - 'description' => '', - ], + ['errorCode' => 'ConfigNotFound', 'errorMessage' => 'The specified configid does not exist.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F61CDR30-E83C-4FDA-BF73-9A94CDD44229\\"\\n}","type":"json"}]', 'title' => 'DeleteHttpResponseHeaderModificationRule', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteHttpResponseHeaderModificationRule', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHttpResponseHeaderModificationRule'], ], ], 'ramActions' => [ @@ -25240,12 +12899,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -25254,12 +12908,8 @@ ], 'DeleteHttpsApplicationConfiguration' => [ 'summary' => 'Delete HTTPS Application Configuration', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -25271,34 +12921,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257618', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'ConfigId of the configuration, which can be obtained by calling the [listHttpsApplicationConfigurations](~~2869087~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'ConfigId of the configuration, which can be obtained by calling the [listHttpsApplicationConfigurations](~~2869087~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '35281609698****', 'title' => ''], ], ], 'responses' => [ @@ -25308,12 +12942,7 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '35C66C7B-671H-4297-9187-2C4477247A78', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '35C66C7B-671H-4297-9187-2C4477247A78'], ], 'example' => '', ], @@ -25321,39 +12950,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], ], 404 => [ - [ - 'errorCode' => 'ConfigNotFound', - 'errorMessage' => 'The specified configid does not exist.', - 'description' => '', - ], + ['errorCode' => 'ConfigNotFound', 'errorMessage' => 'The specified configid does not exist.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35C66C7B-671H-4297-9187-2C4477247A78\\"\\n}","type":"json"}]', 'title' => 'Delete Site HTTPS Application Configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteHttpsApplicationConfiguration', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHttpsApplicationConfiguration'], ], ], 'ramActions' => [ @@ -25364,12 +12974,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -25378,12 +12983,8 @@ ], 'DeleteHttpsBasicConfiguration' => [ 'summary' => 'Delete HTTPS Basic Configuration', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -25395,34 +12996,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257619', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'ConfigId of the configuration, which can be obtained by calling the [ListHttpsBasicConfigurations](~~ListHttpsBasicConfigurations~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '3528160969****', - 'title' => '', - ], + 'schema' => ['description' => 'ConfigId of the configuration, which can be obtained by calling the [ListHttpsBasicConfigurations](~~ListHttpsBasicConfigurations~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '3528160969****', 'title' => ''], ], ], 'responses' => [ @@ -25432,12 +13017,7 @@ 'description' => 'Response Schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9'], ], 'example' => '', ], @@ -25445,39 +13025,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], ], 404 => [ - [ - 'errorCode' => 'ConfigNotFound', - 'errorMessage' => 'The specified configid does not exist.', - 'description' => '', - ], + ['errorCode' => 'ConfigNotFound', 'errorMessage' => 'The specified configid does not exist.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', 'title' => 'Delete Site HTTPS Basic Configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteHttpsBasicConfiguration', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHttpsBasicConfiguration'], ], ], 'ramActions' => [ @@ -25488,12 +13049,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -25502,12 +13058,8 @@ ], 'DeleteImageTransform' => [ 'summary' => 'Delete Site Image Transformation Configuration', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -25519,34 +13071,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257355', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID. It can be obtained by calling the [ListImageTransforms](~~2869056~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '352816096987136', - 'title' => '', - ], + 'schema' => ['description' => 'Configuration ID. It can be obtained by calling the [ListImageTransforms](~~2869056~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '352816096987136', 'title' => ''], ], ], 'responses' => [ @@ -25556,12 +13092,7 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74'], ], 'example' => '', ], @@ -25569,39 +13100,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], ], 404 => [ - [ - 'errorCode' => 'ConfigNotFound', - 'errorMessage' => 'The specified configid does not exist.', - 'description' => '', - ], + ['errorCode' => 'ConfigNotFound', 'errorMessage' => 'The specified configid does not exist.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', 'title' => 'Delete Site Image Transformation Configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteImageTransform', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteImageTransform'], ], ], 'ramActions' => [ @@ -25612,26 +13124,91 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], 'operationType' => 'write', ], - 'DeleteKv' => [ - 'summary' => 'Deletes a key-value pair from a namespace.', - 'methods' => [ - 'get', + 'DeleteKeylessServer' => [ + 'summary' => 'Deletes a keyless server configuration.', + 'methods' => ['get', 'post'], + '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' => 'The ID of the site, which you can get by calling the [ListSites](~~2850189~~) API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11223***', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The keyless server ID.', 'type' => 'string', 'required' => true, 'example' => 'baba39055622c008b90285a8838e****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456****', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com ', 'title' => ''], + 'Id' => ['description' => 'The keyless server ID.', 'type' => 'string', 'example' => 'baba39055622c008b90285a8838e****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Id.MissingParameter', 'errorMessage' => 'The parameter Id is required.', 'description' => 'The required parameter Id is missing.'], + ], + 403 => [ + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], + ], + [ + ['errorCode' => 'Certificate.NotFound', 'errorMessage' => 'The specified certificate does not exist.', 'description' => 'The specified certificate does not exist.'], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'DeleteKeylessServer', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 0,\\n \\"SiteName\\": \\"example.com \\",\\n \\"Id\\": \\"baba39055622c008b90285a8838e****\\",\\n \\"RequestId\\": \\"F61CDR30-E83C-4FDA-BF73-9A94CDD44229\\"\\n}","type":"json"}]', + ], + 'DeleteKv' => [ + 'summary' => 'Delete a specific key-value pair from a namespace.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -25644,47 +13221,28 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238798', - 'abilityTreeNodes' => [ - 'FEATUREdcdnGMYWU5', - ], + 'abilityTreeNodes' => ['FEATUREdcdnGMYWU5'], ], 'parameters' => [ [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace that you specify when you call the [CreateKvNamespace](~~2850317~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_namespace', - 'title' => '', - ], + 'schema' => ['description' => 'The name you specified when you called [CreateKvNamespace](~~2850317~~).', 'type' => 'string', 'required' => true, 'example' => 'test_namespace', 'title' => ''], ], [ 'name' => 'Key', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the key that you want to delete.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_key', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the key to delete.', 'type' => 'string', 'required' => true, 'example' => 'test_key', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'], ], 'example' => '', ], @@ -25692,110 +13250,42 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidAccount.Malformed', - 'errorMessage' => 'The specified account is invalid.', - 'description' => 'The account number is not entered correctly, for example, the input is empty.', - ], - [ - 'errorCode' => 'InvalidNameSpace.Malformed', - 'errorMessage' => 'The specified namespace is invalid.', - 'description' => 'The bucket name is entered incorrectly, such as an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.Malformed', - 'errorMessage' => 'The specified key is invalid.', - 'description' => 'Key name input error, such as entering an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.ExceedsMaximum', - 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', - 'description' => 'The length of the requested key is too large.', - ], - [ - 'errorCode' => 'InvalidValue.ExceedsMaximum', - 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', - 'description' => 'The value deposited is too large.', - ], + ['errorCode' => 'InvalidAccount.Malformed', 'errorMessage' => 'The specified account is invalid.', 'description' => 'The account number is not entered correctly, for example, the input is empty.'], + ['errorCode' => 'InvalidNameSpace.Malformed', 'errorMessage' => 'The specified namespace is invalid.', 'description' => 'The bucket name is entered incorrectly, such as an empty string.'], + ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified key is invalid.', 'description' => 'Key name input error, such as entering an empty string.'], + ['errorCode' => 'InvalidKey.ExceedsMaximum', 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', 'description' => 'The length of the requested key is too large.'], + ['errorCode' => 'InvalidValue.ExceedsMaximum', 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', 'description' => 'The value deposited is too large.'], ], 403 => [ - [ - 'errorCode' => 'InvalidKey.ExceedsCapacity', - 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', - 'description' => 'The capacity of the storage space exceeds the limit.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidParameters', - 'errorMessage' => 'The specified authentication parameters are invalid.', - 'description' => 'Authentication parameter input error.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'InvalidKey.ExceedsCapacity', 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', 'description' => 'The capacity of the storage space exceeds the limit.'], + ['errorCode' => 'Unauthorized.InvalidParameters', 'errorMessage' => 'The specified authentication parameters are invalid.', 'description' => 'Authentication parameter input error.'], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'InvalidAccount.NotFound', - 'errorMessage' => 'The specified account does not exist.', - 'description' => 'The specified account does not exist.', - ], - [ - 'errorCode' => 'InvalidNameSpace.NotFound', - 'errorMessage' => 'The specified namespace does not exist.', - 'description' => '', - ], - [ - 'errorCode' => 'InvalidKey.NotFound', - 'errorMessage' => 'The specified key does not exist.', - 'description' => 'The specified key-value pair does not exist.', - ], + ['errorCode' => 'InvalidAccount.NotFound', 'errorMessage' => 'The specified account does not exist.', 'description' => 'The specified account does not exist.'], + ['errorCode' => 'InvalidNameSpace.NotFound', 'errorMessage' => 'The specified namespace does not exist.', 'description' => ''], + ['errorCode' => 'InvalidKey.NotFound', 'errorMessage' => 'The specified key does not exist.', 'description' => 'The specified key-value pair does not exist.'], ], 406 => [ - [ - 'errorCode' => 'InvalidNameSpace.Duplicate', - 'errorMessage' => 'The specified namespace already exists.', - 'description' => 'Specified storage space', - ], - [ - 'errorCode' => 'InvalidNameSpace.QuotaFull', - 'errorMessage' => 'The maximum number of namespaces is exceeded.', - 'description' => 'The number of storage spaces exceeds the capacity limit.', - ], + ['errorCode' => 'InvalidNameSpace.Duplicate', 'errorMessage' => 'The specified namespace already exists.', 'description' => 'Specified storage space'], + ['errorCode' => 'InvalidNameSpace.QuotaFull', 'errorMessage' => 'The maximum number of namespaces is exceeded.', 'description' => 'The number of storage spaces exceeds the capacity limit.'], ], 429 => [ - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests are submitted.', - 'description' => 'Submissions are too frequent, please try again later', - ], - [ - 'errorCode' => 'TooQuickRequests', - 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', - 'description' => 'The modification or deletion of key-value pairs is too frequent.', - ], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests are submitted.', 'description' => 'Submissions are too frequent, please try again later'], + ['errorCode' => 'TooQuickRequests', 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', 'description' => 'The modification or deletion of key-value pairs is too frequent.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\"\\n}","type":"json"}]', 'title' => 'DeleteKv', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '5', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteKv', - ], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteKv'], ], ], 'ramActions' => [ @@ -25806,29 +13296,17 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\"\\n}","type":"json"}]', ], 'DeleteKvNamespace' => [ - 'summary' => 'Deletes a namespace from an Alibaba Cloud account.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Deletes a namespace from your account.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -25841,23 +13319,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239195', - 'abilityTreeNodes' => [ - 'FEATUREdcdnGMYWU5', - ], + 'abilityTreeNodes' => ['FEATUREdcdnGMYWU5'], ], 'parameters' => [ [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace that you specify when you call the [CreateKvNamespace](~~2850317~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_namespace', - 'maxLength' => 64, - 'pattern' => '^[0-9a-zA-Z_-]+$', - 'title' => '', - ], + 'schema' => ['description' => 'The name that you specified when you called [CreateKvNamespace](~~2850317~~).', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'pattern' => '^[0-9a-zA-Z_-]+$', 'example' => 'test_namespace', 'title' => ''], ], ], 'responses' => [ @@ -25865,12 +13333,7 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', 'title' => ''], ], 'description' => '', 'title' => '', @@ -25880,119 +13343,44 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidAccount.Malformed', - 'errorMessage' => 'The specified account is invalid.', - 'description' => 'The account number is not entered correctly, for example, the input is empty.', - ], - [ - 'errorCode' => 'InvalidNameSpace.Malformed', - 'errorMessage' => 'The specified namespace is invalid.', - 'description' => 'The bucket name is entered incorrectly, such as an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.Malformed', - 'errorMessage' => 'The specified key is invalid.', - 'description' => 'Key name input error, such as entering an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.ExceedsMaximum', - 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', - 'description' => 'The length of the requested key is too large.', - ], - [ - 'errorCode' => 'InvalidValue.ExceedsMaximum', - 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', - 'description' => 'The value deposited is too large.', - ], + ['errorCode' => 'InvalidAccount.Malformed', 'errorMessage' => 'The specified account is invalid.', 'description' => 'The account number is not entered correctly, for example, the input is empty.'], + ['errorCode' => 'InvalidNameSpace.Malformed', 'errorMessage' => 'The specified namespace is invalid.', 'description' => 'The bucket name is entered incorrectly, such as an empty string.'], + ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified key is invalid.', 'description' => 'Key name input error, such as entering an empty string.'], + ['errorCode' => 'InvalidKey.ExceedsMaximum', 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', 'description' => 'The length of the requested key is too large.'], + ['errorCode' => 'InvalidValue.ExceedsMaximum', 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', 'description' => 'The value deposited is too large.'], ], 403 => [ - [ - 'errorCode' => 'InvalidKey.ExceedsCapacity', - 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', - 'description' => 'The capacity of the storage space exceeds the limit.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidParameters', - 'errorMessage' => 'The specified authentication parameters are invalid.', - 'description' => 'Authentication parameter input error.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'InvalidKey.ExceedsCapacity', 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', 'description' => 'The capacity of the storage space exceeds the limit.'], + ['errorCode' => 'Unauthorized.InvalidParameters', 'errorMessage' => 'The specified authentication parameters are invalid.', 'description' => 'Authentication parameter input error.'], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'InvalidAccount.NotFound', - 'errorMessage' => 'The specified account does not exist.', - 'description' => 'The specified account does not exist.', - ], - [ - 'errorCode' => 'InvalidNameSpace.NotFound', - 'errorMessage' => 'The specified namespace does not exist.', - 'description' => '', - ], - [ - 'errorCode' => 'InvalidKey.NotFound', - 'errorMessage' => 'The specified key does not exist.', - 'description' => 'The specified key-value pair does not exist.', - ], + ['errorCode' => 'InvalidAccount.NotFound', 'errorMessage' => 'The specified account does not exist.', 'description' => 'The specified account does not exist.'], + ['errorCode' => 'InvalidNameSpace.NotFound', 'errorMessage' => 'The specified namespace does not exist.', 'description' => ''], + ['errorCode' => 'InvalidKey.NotFound', 'errorMessage' => 'The specified key does not exist.', 'description' => 'The specified key-value pair does not exist.'], ], 406 => [ - [ - 'errorCode' => 'InvalidNameSpace.Duplicate', - 'errorMessage' => 'The specified namespace already exists.', - 'description' => 'Specified storage space', - ], - [ - 'errorCode' => 'InvalidNameSpace.QuotaFull', - 'errorMessage' => 'The maximum number of namespaces is exceeded.', - 'description' => 'The number of storage spaces exceeds the capacity limit.', - ], + ['errorCode' => 'InvalidNameSpace.Duplicate', 'errorMessage' => 'The specified namespace already exists.', 'description' => 'Specified storage space'], + ['errorCode' => 'InvalidNameSpace.QuotaFull', 'errorMessage' => 'The maximum number of namespaces is exceeded.', 'description' => 'The number of storage spaces exceeds the capacity limit.'], ], 429 => [ - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests are submitted.', - 'description' => 'Submissions are too frequent, please try again later', - ], - [ - 'errorCode' => 'TooQuickRequests', - 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', - 'description' => 'The modification or deletion of key-value pairs is too frequent.', - ], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests are submitted.', 'description' => 'Submissions are too frequent, please try again later'], + ['errorCode' => 'TooQuickRequests', 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', 'description' => 'The modification or deletion of key-value pairs is too frequent.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\"\\n}","type":"json"}]', 'title' => 'DeleteKvNamespace', 'changeSet' => [ - [ - 'createdAt' => '2025-04-03T01:43:48.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-04-03T01:43:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '5', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteKvNamespace', - ], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteKvNamespace'], ], ], 'ramActions' => [ @@ -26003,26 +13391,17 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\"\\n}","type":"json"}]', ], 'DeleteList' => [ 'summary' => 'Deletes a custom list that is no longer needed.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -26035,22 +13414,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239621', - 'abilityTreeNodes' => [ - 'FEATUREdcdnL8HX1L', - ], + 'abilityTreeNodes' => ['FEATUREdcdnL8HX1L'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => 'The ID of the custom list, which can be obtained by calling the [ListLists](~~2850217~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '40000001', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the custom list, which can be obtained by calling the [ListLists](~~2850217~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '40000001'], ], ], 'responses' => [ @@ -26060,12 +13430,7 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], ], 'example' => '', ], @@ -26073,49 +13438,23 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], 403 => [ - [ - 'errorCode' => 'List.BeingBound', - 'errorMessage' => 'The specified list is being bound.', - 'description' => 'The specified list is being bound by one or more protection rules.', - ], - [ - 'errorCode' => 'List.NotExist', - 'errorMessage' => 'The specified list does not exist.', - 'description' => 'The specified list does not exist.', - ], + ['errorCode' => 'List.BeingBound', 'errorMessage' => 'The specified list is being bound.', 'description' => 'The specified list is being bound by one or more protection rules.'], + ['errorCode' => 'List.NotExist', 'errorMessage' => 'The specified list does not exist.', 'description' => 'The specified list does not exist.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\"\\n}","type":"json"}]', 'title' => 'DeleteList', 'changeSet' => [ - [ - 'createdAt' => '2024-09-25T07:02:49.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-25T07:02:49.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteList', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteList'], ], ], 'ramActions' => [ @@ -26126,12 +13465,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -26143,12 +13477,8 @@ ], 'DeleteLoadBalancer' => [ 'summary' => 'Delete Load Balancer', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -26161,34 +13491,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238494', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the load balancer, used to uniquely identify the load balancer to be queried. This ID is returned directly upon creation of the load balancer and can also be obtained through the [ListLoadBalancers](~~2868897~~) interface for querying all load balancers under a site.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '99867648760****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the load balancer, used to uniquely identify the load balancer to be queried. This ID is returned directly upon creation of the load balancer and can also be obtained through the [ListLoadBalancers](~~2868897~~) interface for querying all load balancers under a site.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '99867648760****', 'title' => ''], ], [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the site, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1159101787****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the site, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1159101787****', 'title' => ''], ], ], 'responses' => [ @@ -26198,12 +13512,7 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9'], ], 'example' => '', ], @@ -26211,45 +13520,22 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => '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.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', 'title' => 'Delete Load Balancer', 'description' => 'Delete a load balancer by its ID, only one can be deleted at a time.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteLoadBalancer', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLoadBalancer'], ], ], 'ramActions' => [ @@ -26260,12 +13546,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -26277,12 +13558,8 @@ ], 'DeleteNetworkOptimization' => [ 'summary' => 'Delete Network Optimization Configuration', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -26294,34 +13571,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257620', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'ConfigId of the configuration, which can be obtained by calling the ListNetworkOptimizations.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '352816**********', - 'title' => '', - ], + 'schema' => ['description' => 'ConfigId of the configuration, which can be obtained by calling the ListNetworkOptimizations.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '352816**********', 'title' => ''], ], ], 'responses' => [ @@ -26331,12 +13592,7 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'], ], 'example' => '', ], @@ -26344,39 +13600,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], ], 404 => [ - [ - 'errorCode' => 'ConfigNotFound', - 'errorMessage' => 'The specified configid does not exist.', - 'description' => '', - ], + ['errorCode' => 'ConfigNotFound', 'errorMessage' => 'The specified configid does not exist.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', 'title' => 'Delete Site Network Optimization Configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteNetworkOptimization', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteNetworkOptimization'], ], ], 'ramActions' => [ @@ -26387,12 +13624,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -26400,13 +13632,9 @@ 'operationType' => 'write', ], 'DeleteOriginCaCertificate' => [ - 'summary' => 'Delete the source server CA certificate.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Deletes an origin CA certificate.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -26419,67 +13647,31 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '261743', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'babaabcd****', - 'title' => '', - ], + 'schema' => ['description' => 'The certificate ID.', 'type' => 'string', 'required' => true, 'example' => 'babaabcd****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456789****', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com', - 'title' => '', - ], - 'Id' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'example' => 'babaabcd****', - 'title' => '', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E', - 'title' => '', - ], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789****', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'Id' => ['description' => 'The certificate ID.', 'type' => 'string', 'example' => 'babaabcd****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E', 'title' => ''], ], 'example' => '', ], @@ -26487,65 +13679,26 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Certificate.StatusError', - 'errorMessage' => 'The status of the certificate is invalid.', - 'description' => 'The specified certificate status is invalid.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'Id.MissingParameter', - 'errorMessage' => 'The parameter Id is required.', - 'description' => 'The required parameter Id is missing.', - ], + ['errorCode' => 'Certificate.StatusError', 'errorMessage' => 'The status of the certificate is invalid.', 'description' => 'The specified certificate status is invalid.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Id.MissingParameter', 'errorMessage' => 'The parameter Id is required.', 'description' => 'The required parameter Id is missing.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'Certificate.NotFound', - 'errorMessage' => 'The specified certificate does not exist.', - 'description' => 'The specified certificate does not exist.', - ], + ['errorCode' => 'Certificate.NotFound', 'errorMessage' => 'The specified certificate does not exist.', 'description' => 'The specified certificate does not exist.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Delete the source server CA certificate', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '20', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteOriginCaCertificate', - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteOriginCaCertificate'], ], ], 'ramActions' => [ @@ -26556,12 +13709,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -26569,13 +13717,9 @@ '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' => 'Delete the domain name granularity origin fetch client certificate.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Deletes an origin client certificate for a specific site.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -26588,67 +13732,31 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '261752', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the site.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'babaabcd****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the certificate.', 'type' => 'string', 'required' => true, 'example' => 'babaabcd****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456789****', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com'."\n", - 'title' => '', - ], - 'Id' => [ - 'description' => 'The certificate ID.', - 'type' => 'string', - 'example' => 'babaabcd****', - 'title' => '', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - 'title' => '', - ], + 'SiteId' => ['description' => 'The ID of the site.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789****', 'title' => ''], + 'SiteName' => ['description' => 'The name of the site.', 'type' => 'string', 'example' => 'example.com'."\n", 'title' => ''], + 'Id' => ['description' => 'The ID of the certificate.', 'type' => 'string', 'example' => 'babaabcd****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', 'title' => ''], ], 'example' => '', ], @@ -26656,62 +13764,25 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Certificate.StatusError', - 'errorMessage' => 'The status of the certificate is invalid.', - 'description' => 'The specified certificate status is invalid.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'Id.MissingParameter', - 'errorMessage' => 'The parameter Id is required.', - 'description' => 'The required parameter Id is missing.', - ], + ['errorCode' => 'Certificate.StatusError', 'errorMessage' => 'The status of the certificate is invalid.', 'description' => 'The specified certificate status is invalid.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Id.MissingParameter', 'errorMessage' => 'The parameter Id is required.', 'description' => 'The required parameter Id is missing.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'Certificate.NotFound', - 'errorMessage' => 'The specified certificate does not exist.', - 'description' => 'The specified certificate does not exist.', - ], + ['errorCode' => 'Certificate.NotFound', 'errorMessage' => 'The specified certificate does not exist.', 'description' => 'The specified certificate does not exist.'], ], ], 'title' => 'Delete the domain name granularity origin fetch client certificate', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '20', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteOriginClientCertificate', - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteOriginClientCertificate'], ], ], 'ramActions' => [ @@ -26722,12 +13793,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -26736,12 +13802,8 @@ ], 'DeleteOriginPool' => [ 'summary' => 'Delete Origin Address Pool', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -26754,34 +13816,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238349', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the origin address pool, which can be obtained by calling the [ListOriginPools](~~2863947~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '103852052519****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the origin address pool, which can be obtained by calling the [ListOriginPools](~~2863947~~) API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '103852052519****', 'title' => ''], ], [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The site ID, which can be obtained by calling the [ListSites](~~ListSites~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '21655860979****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~ListSites~~) API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '21655860979****', 'title' => ''], ], ], 'responses' => [ @@ -26791,12 +13837,7 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'], ], 'example' => '', ], @@ -26804,49 +13845,22 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'OriginPoolNotExist', - 'errorMessage' => 'The specified origin pool does not exist or does not belong to your account or website. Check and try again.', - 'description' => 'The specified origin pool does not exist or does not belong to your account or website. Check and try again.', - ], - [ - 'errorCode' => 'PoolReferenceExist', - 'errorMessage' => 'Failed to delete the origin pool because it has been referenced.Remove all references to the pool and try again.', - 'description' => 'Failed to delete the origin pool because it has been referenced.Remove all references to the pool and try again.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'OriginPoolNotExist', 'errorMessage' => 'The specified origin pool does not exist or does not belong to your account or website. Check and try again.', 'description' => 'The specified origin pool does not exist or does not belong to your account or website. Check and try again.'], + ['errorCode' => 'PoolReferenceExist', 'errorMessage' => 'Failed to delete the origin pool because it has been referenced.Remove all references to the pool and try again.', 'description' => 'Failed to delete the origin pool because it has been referenced.Remove all references to the pool and try again.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', 'title' => 'Delete Origin Address Pool', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteOriginPool', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteOriginPool'], ], ], 'ramActions' => [ @@ -26857,12 +13871,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -26873,55 +13882,38 @@ ], ], 'DeleteOriginProtection' => [ - 'summary' => 'Disables origin protection.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Disable origin protection.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '250118', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4VDL9A', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4VDL9A'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. For more information, see the [ListSites](~~2850189~~) API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'."\n", - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'."\n"], ], 'example' => '', ], @@ -26929,36 +13921,22 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'OriginProtectionNotExist', - 'errorMessage' => 'The site is not configured with origin protection, so it cannot be modified or deleted.', - 'description' => 'The site is not configured with origin protection, so it cannot be modified or deleted.', - ], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'OriginProtectionNotExist', 'errorMessage' => 'The site is not configured with origin protection, so it cannot be modified or deleted.', 'description' => 'The site is not configured with origin protection, so it cannot be modified or deleted.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\\\n\\"\\n}","type":"json"}]', 'title' => 'DeleteOriginProtection', 'changeSet' => [ - [ - 'createdAt' => '2025-02-21T06:58:57.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-02-21T06:58:57.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '5', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteOriginProtection', - ], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteOriginProtection'], ], ], 'ramActions' => [ @@ -26969,26 +13947,17 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'operationType' => 'write', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\\\n\\"\\n}","type":"json"}]', ], 'DeleteOriginRule' => [ 'summary' => 'Delete Origin Rule Configuration', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -27000,34 +13969,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257621', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '3400350********', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '3400350********', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'ConfigId of the configuration, which can be obtained by calling the [ListOriginRules](~~2866989~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '33793140540****', - 'title' => '', - ], + 'schema' => ['description' => 'ConfigId of the configuration, which can be obtained by calling the [ListOriginRules](~~2866989~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '33793140540****', 'title' => ''], ], ], 'responses' => [ @@ -27037,12 +13990,7 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'], ], 'example' => '', ], @@ -27050,39 +13998,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], ], 404 => [ - [ - 'errorCode' => 'ConfigNotFound', - 'errorMessage' => 'The specified configid does not exist.', - 'description' => '', - ], + ['errorCode' => 'ConfigNotFound', 'errorMessage' => 'The specified configid does not exist.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', 'title' => 'Delete Origin Rule Configuration for Site', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteOriginRule', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteOriginRule'], ], ], 'ramActions' => [ @@ -27093,12 +14022,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -27107,13 +14031,8 @@ ], 'DeletePage' => [ 'summary' => 'Deletes a custom error page that is no longer needed.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -27126,22 +14045,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239625', - 'abilityTreeNodes' => [ - 'FEATUREdcdnL8HX1L', - ], + 'abilityTreeNodes' => ['FEATUREdcdnL8HX1L'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => 'The ID of the custom error page, which can be obtained by calling the [ListPages](~~2850223~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '50000001', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the custom error page, which can be obtained by calling the [ListPages](~~2850223~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '50000001'], ], ], 'responses' => [ @@ -27151,19 +14061,8 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], - 'Id' => [ - 'title' => '', - 'description' => 'The ID of the custom error page.[](~~2850223~~)'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50000001', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], + 'Id' => ['title' => '', 'description' => 'The ID of the custom error page.[](~~2850223~~)'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '50000001'], ], 'example' => '', ], @@ -27171,53 +14070,27 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], 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' => '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.', - ], - [ - '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' => '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.', - ], + ['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' => '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.'], + ['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' => '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.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Id\\": 50000001\\n}","type":"json"}]', 'title' => 'DeletePage', 'changeSet' => [ - [ - 'createdAt' => '2024-09-25T07:02:48.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-25T07:02:48.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeletePage', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePage'], ], ], 'ramActions' => [ @@ -27228,12 +14101,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -27244,13 +14112,9 @@ ], ], 'DeleteRecord' => [ - 'summary' => 'Delete a single DNS record under a site by RecordId. ', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Deletes a DNS record based on its RecordId.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -27263,22 +14127,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239584', - 'abilityTreeNodes' => [ - 'FEATUREdcdnVFT29S', - ], + 'abilityTreeNodes' => ['FEATUREdcdnVFT29S'], ], 'parameters' => [ [ 'name' => 'RecordId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the record, which can be obtained by calling [ListRecords](~~2850265~~). ', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the DNS record. You can get this ID by calling the [ListRecords](~~2850265~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], ], 'responses' => [ @@ -27286,12 +14141,7 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. ', - 'type' => 'string', - 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229'], ], 'description' => '', 'title' => '', @@ -27301,43 +14151,15 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'Record.Reserved', - 'errorMessage' => 'Another operation on the record is in progress. Try again later.', - 'description' => 'Another operation on the record is in progress. Try again later.', - ], - [ - 'errorCode' => 'Record.ServiceBusy', - 'errorMessage' => 'The record is being configured. Try again later.', - 'description' => 'The record is being configured. Try again later.', - ], - [ - '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' => 'Failed to delete the record because it is the origin server of existing custom hostnames.Remove all references to the record and try again.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => '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.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'Record.Reserved', 'errorMessage' => 'Another operation on the record is in progress. Try again later.', 'description' => 'Another operation on the record is in progress. Try again later.'], + ['errorCode' => 'Record.ServiceBusy', 'errorMessage' => 'The record is being configured. Try again later.', 'description' => 'The record is being configured. Try again later.'], + ['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' => 'Failed to delete the record because it is the origin server of existing custom hostnames.Remove all references to the record and try again.'], ], 404 => [ - [ - 'errorCode' => 'Record.NotFound', - 'errorMessage' => 'The record does not exist. Check your configurations and try again.', - 'description' => 'The record does not exist. Check your configurations and try again.', - ], + ['errorCode' => 'Record.NotFound', 'errorMessage' => 'The record does not exist. Check your configurations and try again.', 'description' => 'The record does not exist. Check your configurations and try again.'], ], ], 'eventInfo' => [ @@ -27348,12 +14170,7 @@ 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '10', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteRecord', - ], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRecord'], ], ], 'ramActions' => [ @@ -27364,12 +14181,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -27378,12 +14190,8 @@ ], 'DeleteRedirectRule' => [ 'summary' => 'Deletes a URL redirect rule for a website.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -27395,34 +14203,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257661', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration ID, which can be obtained by calling the [ListRedirectRules](~~ListRedirectRules~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID, which can be obtained by calling the [ListRedirectRules](~~ListRedirectRules~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '35281609698****', 'title' => ''], ], ], 'responses' => [ @@ -27432,12 +14224,7 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'BF9B849D-D847-5B16-9371-8ECB557A5921', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'BF9B849D-D847-5B16-9371-8ECB557A5921'], ], 'example' => '', ], @@ -27445,39 +14232,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], ], 404 => [ - [ - 'errorCode' => 'ConfigNotFound', - 'errorMessage' => 'The specified configid does not exist.', - 'description' => '', - ], + ['errorCode' => 'ConfigNotFound', 'errorMessage' => 'The specified configid does not exist.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BF9B849D-D847-5B16-9371-8ECB557A5921\\"\\n}","type":"json"}]', 'title' => 'DeleteRedirectRule', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteRedirectRule', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRedirectRule'], ], ], 'ramActions' => [ @@ -27488,12 +14256,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -27502,12 +14265,8 @@ ], 'DeleteRewriteUrlRule' => [ 'summary' => 'Deletes a URL rewrite rule for a website.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -27519,34 +14278,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257645', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration ID, which can be obtained by calling the [ListRewriteUrlRules](~~ListRewriteUrlRules~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID, which can be obtained by calling the [ListRewriteUrlRules](~~ListRewriteUrlRules~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '35281609698****', 'title' => ''], ], ], 'responses' => [ @@ -27556,12 +14299,7 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '35C66C7B-671H-4297-9187-2C4477247A78', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '35C66C7B-671H-4297-9187-2C4477247A78'], ], 'example' => '', ], @@ -27569,39 +14307,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], ], 404 => [ - [ - 'errorCode' => 'ConfigNotFound', - 'errorMessage' => 'The specified configid does not exist.', - 'description' => '', - ], + ['errorCode' => 'ConfigNotFound', 'errorMessage' => 'The specified configid does not exist.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35C66C7B-671H-4297-9187-2C4477247A78\\"\\n}","type":"json"}]', 'title' => 'DeleteRewriteUrlRule', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteRewriteUrlRule', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRewriteUrlRule'], ], ], 'ramActions' => [ @@ -27612,12 +14331,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -27625,63 +14339,39 @@ 'operationType' => 'write', ], 'DeleteRoutine' => [ - 'summary' => 'Deletes a routine in Edge Routine.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238943', - 'abilityTreeNodes' => [ - 'FEATUREdcdn75UYDO', - ], + 'abilityTreeNodes' => ['FEATUREdcdn75UYDO'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The routine name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-routine1', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Edge Routine.', 'type' => 'string', 'required' => true, 'example' => 'test-routine1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', - ], - 'Status' => [ - 'description' => 'Indicates whether the operation is successful.'."\n", - 'type' => 'string', - 'example' => 'OK', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395'], + 'Status' => ['description' => 'The status of the operation, which indicates success or failure.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'example' => '', ], @@ -27689,109 +14379,47 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'RoutineNotExist', - 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', - 'description' => 'The routine name does not exist. Check the routine name and try again.', - ], - [ - 'errorCode' => 'DependedByOthers', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'SiteParameterNotMatch', - 'errorMessage' => 'Failed to verify website parameters.Check the parameters and try again.', - 'description' => 'Failed to verify website parameters.Check the parameters and try again.', - ], - [ - 'errorCode' => 'RoutineUserServiceStatusHalt', - 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', - 'description' => 'Failed to update the configurations because you have overdue payments.', - ], - [ - 'errorCode' => 'InternalOperationError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'ParameterNotExist', - 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', - 'description' => 'The specified parameter does not exist. Check your configurations and try again.', - ], - [ - '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' => 'Failed to delete the code version because it is being used. Before you delete it, roll back to the previous version.', - ], - [ - 'errorCode' => 'UserOperationStatusIsLocked', - 'errorMessage' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', - 'description' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'RoutineNotExist', 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', 'description' => 'The routine name does not exist. Check the routine name and try again.'], + ['errorCode' => 'DependedByOthers', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'SiteParameterNotMatch', 'errorMessage' => 'Failed to verify website parameters.Check the parameters and try again.', 'description' => 'Failed to verify website parameters.Check the parameters and try again.'], + ['errorCode' => 'RoutineUserServiceStatusHalt', 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', 'description' => 'Failed to update the configurations because you have overdue payments.'], + ['errorCode' => 'InternalOperationError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'ParameterNotExist', 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', 'description' => 'The specified parameter does not exist. Check your configurations and try again.'], + ['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' => 'Failed to delete the code version because it is being used. Before you delete it, roll back to the previous version.'], + ['errorCode' => 'UserOperationStatusIsLocked', 'errorMessage' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', 'description' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"Status\\": \\"OK\\"\\n}","type":"json"}]', - 'title' => 'DeleteRoutine', + 'title' => 'Delete an edge routine', + 'summary' => 'Deletes an Edge Routine.', 'changeSet' => [ - [ - 'createdAt' => '2024-12-04T05:48:48.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-11-05T06:54:07.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-12-04T05:48:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-05T06:54:07.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '1', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteRoutine', - ], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRoutine'], ], ], 'ramActions' => [ [ - 'operationType' => 'none', + 'operationType' => 'delete', 'ramAction' => [ 'action' => 'esa:DeleteRoutine', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'operationType' => 'write', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"Status\\": \\"OK\\"\\n}","type":"json"}]', ], 'DeleteRoutineCodeVersion' => [ - 'summary' => 'Deletes a code version of a routine.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -27804,53 +14432,29 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238902', - 'abilityTreeNodes' => [ - 'FEATUREdcdn75UYDO', - ], + 'abilityTreeNodes' => ['FEATUREdcdn75UYDO'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The routine name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-routine1', - 'title' => '', - ], + 'schema' => ['description' => 'The routine name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-routine1', 'title' => ''], ], [ 'name' => 'CodeVersion', 'in' => 'formData', - 'schema' => [ - 'description' => 'The code version.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1710120201067203242', - 'title' => '', - ], + 'schema' => ['description' => 'The code version.'."\n", 'type' => 'string', 'required' => true, 'example' => '1710120201067203242', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', - ], - 'Status' => [ - 'description' => 'Indicates whether the operation is successful.'."\n", - 'type' => 'string', - 'example' => 'OK', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395'], + 'Status' => ['description' => 'Indicates whether the operation is successful.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'example' => '', ], @@ -27858,81 +14462,28 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'RoutineNotExist', - 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', - 'description' => 'The routine name does not exist. Check the routine name and try again.', - ], - [ - 'errorCode' => 'DependedByOthers', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'SiteParameterNotMatch', - 'errorMessage' => 'Failed to verify website parameters.Check the parameters and try again.', - 'description' => 'Failed to verify website parameters.Check the parameters and try again.', - ], - [ - 'errorCode' => 'RoutineUserServiceStatusHalt', - 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', - 'description' => 'Failed to update the configurations because you have overdue payments.', - ], - [ - 'errorCode' => 'InternalOperationError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'ParameterNotExist', - 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', - 'description' => 'The specified parameter does not exist. Check your configurations and try again.', - ], - [ - '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' => 'Failed to delete the code version because it is being used. Before you delete it, roll back to the previous version.', - ], - [ - 'errorCode' => 'UserOperationStatusIsLocked', - 'errorMessage' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', - 'description' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'RoutineNotExist', 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', 'description' => 'The routine name does not exist. Check the routine name and try again.'], + ['errorCode' => 'DependedByOthers', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'SiteParameterNotMatch', 'errorMessage' => 'Failed to verify website parameters.Check the parameters and try again.', 'description' => 'Failed to verify website parameters.Check the parameters and try again.'], + ['errorCode' => 'RoutineUserServiceStatusHalt', 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', 'description' => 'Failed to update the configurations because you have overdue payments.'], + ['errorCode' => 'InternalOperationError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'ParameterNotExist', 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', 'description' => 'The specified parameter does not exist. Check your configurations and try again.'], + ['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' => 'Failed to delete the code version because it is being used. Before you delete it, roll back to the previous version.'], + ['errorCode' => 'UserOperationStatusIsLocked', 'errorMessage' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', 'description' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"Status\\": \\"OK\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteRoutineCodeVersion', + 'summary' => 'Deletes a code version of a routine.', 'changeSet' => [ - [ - 'createdAt' => '2024-12-04T05:48:47.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-11-05T06:54:07.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-12-04T05:48:47.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-05T06:54:07.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '5', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteRoutineCodeVersion', - ], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRoutineCodeVersion'], ], ], 'ramActions' => [ @@ -27943,112 +14494,64 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"Status\\": \\"OK\\"\\n}","type":"json"}]', ], 'DeleteRoutineRelatedRecord' => [ - 'summary' => 'Deletes a record that is associated with a routine.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239362', - 'abilityTreeNodes' => [ - 'FEATUREdcdn75UYDO', - ], + 'abilityTreeNodes' => ['FEATUREdcdn75UYDO'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The routine name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-xxx', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Edge Routine.', 'type' => 'string', 'required' => true, 'example' => 'test-xxx', 'title' => ''], ], [ 'name' => 'RecordId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The record ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12345'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The record ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345'."\n", 'title' => ''], ], [ 'name' => 'RecordName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The record name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-xxx.example.com', - 'title' => '', - ], + 'schema' => ['description' => 'The record name.', 'type' => 'string', 'required' => true, 'example' => 'test-xxx.example.com', 'title' => ''], ], [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12345', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', - ], - 'Status' => [ - 'description' => 'Indicates whether the operation is successful.'."\n" - ."\n" - .'* OK'."\n" - .'* Fail'."\n", - 'type' => 'string', - 'example' => 'OK', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395'], + 'Status' => ['description' => 'The operation status. Valid values:'."\n" + ."\n" + .'* **OK**: The operation was successful.'."\n" + .'* **Fail**: The operation failed.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'example' => '', ], @@ -28056,69 +14559,28 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'RoutineNotExist', - 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', - 'description' => 'The routine name does not exist. Check the routine name and try again.', - ], - [ - 'errorCode' => 'DependedByOthers', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'SiteParameterNotMatch', - 'errorMessage' => 'Failed to verify website parameters.Check the parameters and try again.', - 'description' => 'Failed to verify website parameters.Check the parameters and try again.', - ], - [ - 'errorCode' => 'RoutineUserServiceStatusHalt', - 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', - 'description' => 'Failed to update the configurations because you have overdue payments.', - ], - [ - 'errorCode' => 'InternalOperationError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'ParameterNotExist', - 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', - 'description' => 'The specified parameter does not exist. Check your configurations and try again.', - ], - [ - 'errorCode' => 'UserOperationStatusIsLocked', - 'errorMessage' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', - 'description' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'RoutineNotExist', 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', 'description' => 'The routine name does not exist. Check the routine name and try again.'], + ['errorCode' => 'DependedByOthers', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'SiteParameterNotMatch', 'errorMessage' => 'Failed to verify website parameters.Check the parameters and try again.', 'description' => 'Failed to verify website parameters.Check the parameters and try again.'], + ['errorCode' => 'RoutineUserServiceStatusHalt', 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', 'description' => 'Failed to update the configurations because you have overdue payments.'], + ['errorCode' => 'InternalOperationError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'ParameterNotExist', 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', 'description' => 'The specified parameter does not exist. Check your configurations and try again.'], + ['errorCode' => 'UserOperationStatusIsLocked', 'errorMessage' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', 'description' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'DeleteRoutineRelatedRecord', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete an edge routine association record', + 'summary' => 'Deletes an association record of an Edge Routine.', 'changeSet' => [ - [ - 'createdAt' => '2024-12-04T05:48:48.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-11-05T06:54:06.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-12-04T05:48:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-05T06:54:06.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRoutineRelatedRecord'], + ], ], 'ramActions' => [ [ @@ -28128,27 +14590,17 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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"}]', - 'operationType' => 'write', ], 'DeleteRoutineRoute' => [ 'summary' => 'Deletes the route configuration of an edge function.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -28161,34 +14613,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '266192', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11223***', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11223***', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the configuration. You can call the [ListSiteRoutes](~~2879631~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '3528160969****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the configuration. You can call the [ListSiteRoutes](~~2879631~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '3528160969****', 'title' => ''], ], ], 'responses' => [ @@ -28198,12 +14634,7 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9'], ], 'example' => '', ], @@ -28211,23 +14642,11 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], ], 404 => [ - [ - 'errorCode' => 'ConfigNotFound', - 'errorMessage' => 'The specified configid does not exist.', - 'description' => '', - ], + ['errorCode' => 'ConfigNotFound', 'errorMessage' => 'The specified configid does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', @@ -28235,12 +14654,7 @@ 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '20', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteRoutineRoute', - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRoutineRoute'], ], ], 'ramActions' => [ @@ -28251,25 +14665,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], ], 'DeleteScheduledPreloadExecution' => [ - 'summary' => 'Deletes a scheduled prefetch plan based on the plan ID.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Deletes a single scheduled preload plan.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -28282,36 +14687,23 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238929', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4TTNAL', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4TTNAL'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the prefetch plan.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '665d3b48621bccf3fe29e1a7', - 'title' => '', - ], + 'schema' => ['description' => 'The preload plan ID.', 'type' => 'string', 'required' => true, 'example' => '665d3b48621bccf3fe29e1a7', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'], ], 'example' => '', ], @@ -28319,76 +14711,32 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], - [ - 'errorCode' => 'InvalidJob.JobCountOfSiteFull', - 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', - 'description' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', - ], - [ - 'errorCode' => 'InvalidParameter.ObjectId', - 'errorMessage' => 'Invalid task ID or execution plan ID.', - 'description' => 'Invalid task ID or execution plan ID.', - ], - [ - 'errorCode' => 'MissingOssUrl', - 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', - 'description' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', - ], - [ - 'errorCode' => 'MissingUrlList', - 'errorMessage' => 'Enter the URLs you want to prefetch.', - 'description' => 'Enter the URLs you want to prefetch.', - ], - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests.Please try again later.', - 'description' => 'Requests are too frequent, please try again later.', - ], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'InvalidJob.JobCountOfSiteFull', 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', 'description' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.'], + ['errorCode' => 'InvalidParameter.ObjectId', 'errorMessage' => 'Invalid task ID or execution plan ID.', 'description' => 'Invalid task ID or execution plan ID.'], + ['errorCode' => 'MissingOssUrl', 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', 'description' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.'], + ['errorCode' => 'MissingUrlList', 'errorMessage' => 'Enter the URLs you want to prefetch.', 'description' => 'Enter the URLs you want to prefetch.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], ], 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' => '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.', - ], + ['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' => '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.'], ], [ - [ - 'errorCode' => 'InvalidJob.NotFound', - 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', - 'description' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', - ], - [ - 'errorCode' => 'LogNotFound', - 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', - 'description' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', - ], - [ - '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' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.', - ], + ['errorCode' => 'InvalidJob.NotFound', 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', 'description' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.'], + ['errorCode' => 'LogNotFound', 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', 'description' => 'Failed to query the log. Check whether the task ID and execution ID are valid.'], + ['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' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', 'title' => 'DeleteScheduledPreloadExecution', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteScheduledPreloadExecution', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteScheduledPreloadExecution'], ], ], 'ramActions' => [ @@ -28399,29 +14747,16 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', ], 'DeleteScheduledPreloadJob' => [ - 'summary' => 'Deletes a specified scheduled prefetch task based on the task ID.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -28434,36 +14769,23 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239180', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4TTNAL', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4TTNAL'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the scheduled prefetch task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '665d3af3621bccf3fe29e1a4'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The scheduled preload job ID.', 'type' => 'string', 'required' => true, 'example' => '665d3af3621bccf3fe29e1a4'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E'], ], 'example' => '', ], @@ -28471,76 +14793,33 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], - [ - 'errorCode' => 'InvalidJob.JobCountOfSiteFull', - 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', - 'description' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', - ], - [ - 'errorCode' => 'InvalidParameter.ObjectId', - 'errorMessage' => 'Invalid task ID or execution plan ID.', - 'description' => 'Invalid task ID or execution plan ID.', - ], - [ - 'errorCode' => 'MissingOssUrl', - 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', - 'description' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', - ], - [ - 'errorCode' => 'MissingUrlList', - 'errorMessage' => 'Enter the URLs you want to prefetch.', - 'description' => 'Enter the URLs you want to prefetch.', - ], - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests.Please try again later.', - 'description' => 'Requests are too frequent, please try again later.', - ], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'InvalidJob.JobCountOfSiteFull', 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', 'description' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.'], + ['errorCode' => 'InvalidParameter.ObjectId', 'errorMessage' => 'Invalid task ID or execution plan ID.', 'description' => 'Invalid task ID or execution plan ID.'], + ['errorCode' => 'MissingOssUrl', 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', 'description' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.'], + ['errorCode' => 'MissingUrlList', 'errorMessage' => 'Enter the URLs you want to prefetch.', 'description' => 'Enter the URLs you want to prefetch.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], ], 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' => '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.', - ], + ['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' => '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.'], ], [ - [ - 'errorCode' => 'InvalidJob.NotFound', - 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', - 'description' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', - ], - [ - 'errorCode' => 'LogNotFound', - 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', - 'description' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', - ], - [ - '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' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.', - ], + ['errorCode' => 'InvalidJob.NotFound', 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', 'description' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.'], + ['errorCode' => 'LogNotFound', 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', 'description' => 'Failed to query the log. Check whether the task ID and execution ID are valid.'], + ['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' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C370DAF1-C838-4288-A1A0-9A87633D248E\\"\\n}","type":"json"}]', 'title' => 'DeleteScheduledPreloadJob', + 'summary' => 'Deletes a specified scheduled preload job.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteScheduledPreloadJob', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteScheduledPreloadJob'], ], ], 'ramActions' => [ @@ -28551,29 +14830,16 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C370DAF1-C838-4288-A1A0-9A87633D248E\\"\\n}","type":"json"}]', ], 'DeleteSite' => [ - 'summary' => 'Deletes a website based on the specified website ID.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -28586,22 +14852,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239599', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the site to delete. Call the [ListSites](~~2850189~~) operation to obtain site IDs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], ], 'responses' => [ @@ -28609,12 +14866,7 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247B78', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247B78', 'title' => ''], ], 'description' => '', 'title' => '', @@ -28624,71 +14876,29 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'Site.ServiceBusy', - 'errorMessage' => 'This website is being configured. Try again later.', - 'description' => 'This website is being configured. Try again later.', - ], - [ - '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' => '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).', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Site.ServiceBusy', 'errorMessage' => 'This website is being configured. Try again later.', 'description' => 'This website is being configured. Try again later.'], + ['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' => '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).'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247B78\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteSite', + 'summary' => 'Deletes a site by site ID.', 'changeSet' => [ - [ - 'createdAt' => '2025-01-10T01:51:16.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-01-10T01:51:16.000Z', 'description' => 'Error codes changed'], ], '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}', - ], - ], - ], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSite'], ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247B78\\"\\n}","type":"json"}]', ], 'DeleteSiteDeliveryTask' => [ 'summary' => 'Deletes a real-time log delivery task.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -28700,33 +14910,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239145', - 'abilityTreeNodes' => [ - 'FEATUREdcdn9K10I1', - ], + 'abilityTreeNodes' => ['FEATUREdcdn9K10I1'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456******', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456******', 'title' => ''], ], [ 'name' => 'TaskName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the delivery task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cdn-test-task', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the delivery task.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cdn-test-task', 'title' => ''], ], ], 'responses' => [ @@ -28736,12 +14931,7 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229'], ], 'example' => '', ], @@ -28749,48 +14939,23 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], ], 403 => [ - [ - 'errorCode' => 'EsaService.NotOpen', - 'errorMessage' => 'ESA service has not opend.', - 'description' => 'Edge Security Accelerator (ESA) is not turned on', - ], + ['errorCode' => 'EsaService.NotOpen', 'errorMessage' => 'ESA service has not opend.', 'description' => 'Edge Security Accelerator (ESA) is not turned on'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F61CDR30-E83C-4FDA-BF73-9A94CDD44229\\"\\n}","type":"json"}]', 'title' => 'DeleteSiteDeliveryTask', 'changeSet' => [ - [ - 'createdAt' => '2024-10-18T01:07:12.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-27T05:57:02.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-10-18T01:07:12.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-27T05:57:02.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteSiteDeliveryTask', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSiteDeliveryTask'], ], ], 'ramActions' => [ @@ -28801,12 +14966,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -28818,12 +14978,8 @@ ], ], 'DeleteSiteOriginClientCertificate' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -28836,67 +14992,31 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '261745', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The certificate ID on ESA.', - 'type' => 'string', - 'required' => true, - 'example' => 'babaabcd****', - 'title' => '', - ], + 'schema' => ['description' => 'The certificate ID.', 'type' => 'string', 'required' => true, 'example' => 'babaabcd****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'SiteId' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456789****', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com'."\n", - 'title' => '', - ], - 'Id' => [ - 'description' => 'The certificate ID on ESA.', - 'type' => 'string', - 'example' => 'babaabcd****', - 'title' => '', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - 'title' => '', - ], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789****', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com'."\n", 'title' => ''], + 'Id' => ['description' => 'The certificate ID.', 'type' => 'string', 'example' => 'babaabcd****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', 'title' => ''], ], 'example' => '', ], @@ -28904,63 +15024,26 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Certificate.StatusError', - 'errorMessage' => 'The status of the certificate is invalid.', - 'description' => 'The specified certificate status is invalid.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'Id.MissingParameter', - 'errorMessage' => 'The parameter Id is required.', - 'description' => 'The required parameter Id is missing.', - ], + ['errorCode' => 'Certificate.StatusError', 'errorMessage' => 'The status of the certificate is invalid.', 'description' => 'The specified certificate status is invalid.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Id.MissingParameter', 'errorMessage' => 'The parameter Id is required.', 'description' => 'The required parameter Id is missing.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'Certificate.NotFound', - 'errorMessage' => 'The specified certificate does not exist.', - 'description' => 'The specified certificate does not exist.', - ], + ['errorCode' => 'Certificate.NotFound', 'errorMessage' => 'The specified certificate does not exist.', 'description' => 'The specified certificate does not exist.'], ], ], 'title' => 'Delete the site-granularity origin fetch client certificate', - 'summary' => 'Delete the site-granularity origin fetch client certificate.', + 'summary' => 'Deletes a site-level origin client certificate.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '20', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteSiteOriginClientCertificate', - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSiteOriginClientCertificate'], ], ], 'ramActions' => [ @@ -28971,12 +15054,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -28985,12 +15063,8 @@ ], 'DeleteTransportLayerApplication' => [ 'summary' => 'Delete Transport Layer Application', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -29003,34 +15077,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '245121', - 'abilityTreeNodes' => [ - 'FEATUREdcdn2E10XY', - ], + 'abilityTreeNodes' => ['FEATUREdcdn2E10XY'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => 'Application ID, which can be obtained by calling the [ListTransportLayerApplications](~~ListTransportLayerApplications~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '170996390868****', - 'title' => '', - ], + 'schema' => ['description' => 'Application ID, which can be obtained by calling the [ListTransportLayerApplications](~~ListTransportLayerApplications~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '170996390868****', 'title' => ''], ], ], 'responses' => [ @@ -29039,12 +15097,7 @@ 'description' => 'Request response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '90510C29-1E40-5A11-93F1-B9F5EDF57EE1', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '90510C29-1E40-5A11-93F1-B9F5EDF57EE1'], ], 'title' => '', 'example' => '', @@ -29053,31 +15106,13 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'TransportLayerApplicationNotExist', - 'errorMessage' => 'The layer -4 accelerated application of the current operation does not exist. Modify it and try again.', - 'description' => 'The layer -4 accelerated application of the current operation does not exist. Modify it and try again.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], - [ - 'errorCode' => 'IpaNotActive', - 'errorMessage' => 'The ipa application is not active.', - 'description' => 'The ipa application is not active.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'TransportLayerApplicationNotExist', 'errorMessage' => 'The layer -4 accelerated application of the current operation does not exist. Modify it and try again.', 'description' => 'The layer -4 accelerated application of the current operation does not exist. Modify it and try again.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['errorCode' => 'IpaNotActive', 'errorMessage' => 'The ipa application is not active.', 'description' => 'The ipa application is not active.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], @@ -29096,12 +15131,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -29110,12 +15140,8 @@ 'DeleteUrlObservation' => [ 'summary' => 'Deletes page monitoring configurations.', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -29128,34 +15154,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '264796', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration ID, which can be obtained by calling the [ListUrlObservations](~~ListUrlObservations~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID, which can be obtained by calling the [ListUrlObservations](~~ListUrlObservations~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '35281609698****', 'title' => ''], ], ], 'responses' => [ @@ -29165,12 +15175,7 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74'], ], 'example' => '', ], @@ -29178,32 +15183,17 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', 'title' => 'DeleteUrlObservation', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteUrlObservation', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUrlObservation'], ], ], 'ramActions' => [ @@ -29214,12 +15204,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -29227,12 +15212,8 @@ ], 'DeleteUserDeliveryTask' => [ 'summary' => 'Deletes a log delivery task from your Alibaba Cloud account.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -29245,21 +15226,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239170', - 'abilityTreeNodes' => [ - 'FEATUREdcdn9K10I1', - ], + 'abilityTreeNodes' => ['FEATUREdcdn9K10I1'], ], 'parameters' => [ [ 'name' => 'TaskName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the delivery task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the delivery task.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], ], 'responses' => [ @@ -29269,12 +15242,7 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '952ea16b-1f05-4a76-bb32-420282d8aeb9', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '952ea16b-1f05-4a76-bb32-420282d8aeb9'], ], 'example' => '', ], @@ -29282,33 +15250,15 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'ErService.HasOpened', - 'errorMessage' => 'You have already activated Edge Routine.', - 'description' => 'You have already activated Edge Routine.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'ErService.HasOpened', 'errorMessage' => 'You have already activated Edge Routine.', 'description' => 'You have already activated Edge Routine.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], ], 403 => [ - [ - 'errorCode' => 'EsaService.NotOpen', - 'errorMessage' => 'ESA service has not opend.', - 'description' => 'Edge Security Accelerator (ESA) is not turned on', - ], + ['errorCode' => 'EsaService.NotOpen', 'errorMessage' => 'ESA service has not opend.', 'description' => 'Edge Security Accelerator (ESA) is not turned on'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"952ea16b-1f05-4a76-bb32-420282d8aeb9\\"\\n}","type":"json"}]', 'title' => 'DeleteUserDeliveryTask', 'description' => '******> '."\n" @@ -29317,23 +15267,12 @@ .'* To call this operation, you must have an account that has the required permissions.'."\n" .'* The returned `RequestId` value can be used to track the request processing progress and troubleshoot issues.'."\n", 'changeSet' => [ - [ - 'createdAt' => '2024-10-18T01:07:11.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-27T05:57:02.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-10-18T01:07:11.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-27T05:57:02.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteUserDeliveryTask', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUserDeliveryTask'], ], ], 'ramActions' => [ @@ -29344,12 +15283,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -29364,13 +15298,8 @@ 'description' => '## Request description'."\n" ."\n" .'- The `InstanceId` and `Id` parameters are required. These parameters specify the ID of the WAF instance and the ID of the ruleset to delete.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -29382,37 +15311,18 @@ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdcdnV3YEJ8', - 'FEATUREdcdnUTRW1O', - 'FEATUREdcdnSU2QP6', - 'FEATUREdcdnV3G3FZ', - 'FEATUREdcdnBQ0J3E', - ], + 'abilityTreeNodes' => ['FEATUREdcdnV3YEJ8', 'FEATUREdcdnUTRW1O', 'FEATUREdcdnSU2QP6', 'FEATUREdcdnV3G3FZ', 'FEATUREdcdnBQ0J3E'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance.', - 'type' => 'string', - 'required' => true, - 'example' => 'esa-xxxxxxx', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'esa-xxxxxxx', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the WAF ruleset.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10000001', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the WAF ruleset.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000001', 'title' => ''], ], ], 'responses' => [ @@ -29423,12 +15333,7 @@ 'description' => 'The schema of the response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => 'xxxx-xxxx-xxxx-xxxx', - 'title' => '', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxx', 'title' => ''], ], 'example' => '', ], @@ -29436,33 +15341,15 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], 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' => '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.', - ], + ['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' => '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.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteUserWafRuleset', 'changeSet' => [], 'flowControl' => [ @@ -29476,12 +15363,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -29490,12 +15372,8 @@ ], 'DeleteVideoProcessing' => [ 'summary' => 'Deletes a video processing configuration.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -29508,34 +15386,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257667', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration ID. You can call the [ListVideoProcessings](~~ListVideoProcessings~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID. You can call the [ListVideoProcessings](~~ListVideoProcessings~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '35281609698****', 'title' => ''], ], ], 'responses' => [ @@ -29545,12 +15407,7 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6abd807e-ed2a-44de-ac54-ac38a62472e6', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6abd807e-ed2a-44de-ac54-ac38a62472e6'], ], 'example' => '', ], @@ -29558,28 +15415,14 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], ], 404 => [ - [ - 'errorCode' => 'ConfigNotFound', - 'errorMessage' => 'The specified configid does not exist.', - 'description' => '', - ], + ['errorCode' => 'ConfigNotFound', 'errorMessage' => 'The specified configid does not exist.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6abd807e-ed2a-44de-ac54-ac38a62472e6\\"\\n}","type":"json"}]', 'title' => 'DeleteVideoProcessing', 'changeSet' => [], @@ -29594,26 +15437,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], ], 'DeleteWafRule' => [ - 'summary' => 'Delete WAF Rule', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Deletes a specified rule in Web Application Firewall (WAF). This operation also deletes the configurations and conditions associated with the rule.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -29626,63 +15459,33 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239585', - 'abilityTreeNodes' => [ - 'FEATUREdcdnUTRW1O', - 'FEATUREdcdnSU2QP6', - 'FEATUREdcdnV3G3FZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdnUTRW1O', 'FEATUREdcdnSU2QP6', 'FEATUREdcdnV3G3FZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'title' => '站点ID', - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '站点ID', 'description' => 'The site ID. You can obtain this ID by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Site version.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. If configuration version management is enabled, this parameter specifies the site version to which the configuration applies. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'title' => '规则ID', - 'description' => 'ID of the WAF rule, which can be obtained by calling the [ListWafRules](~~2878257~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20000001', - ], + 'schema' => ['title' => '规则ID', 'description' => 'The ID of the WAF rule. You can obtain this ID by calling the [ListWafRules](~~2878257~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20000001'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], ], 'example' => '', ], @@ -29690,47 +15493,21 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'Rule.NotExist', - 'errorMessage' => 'The specified rule does not exist.', - 'description' => 'The specified rule does not exist in the current context or system configuration. Please verify the existence of the rule identifier and ensure it has been correctly defined or implemented.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'Rule.NotExist', 'errorMessage' => 'The specified rule does not exist.', 'description' => 'The specified rule does not exist in the current context or system configuration. Please verify the existence of the rule identifier and ensure it has been correctly defined or implemented.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\"\\n}","type":"json"}]', 'title' => 'Delete WAF Rule', 'changeSet' => [ - [ - 'createdAt' => '2024-09-25T07:02:52.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-25T07:02:52.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteWafRule', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWafRule'], ], ], 'ramActions' => [ @@ -29741,26 +15518,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], ], 'DeleteWafRuleset' => [ - 'summary' => 'Delete WAF Ruleset', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Deletes a specified Web Application Firewall (WAF) ruleset.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -29773,62 +15540,33 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239657', - 'abilityTreeNodes' => [ - 'FEATUREdcdnBQ0J3E', - 'FEATUREdcdn1OLUH8', - ], + 'abilityTreeNodes' => ['FEATUREdcdnBQ0J3E', 'FEATUREdcdn1OLUH8'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'title' => '站点ID', - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '站点ID', 'description' => 'The site ID. Call the [ListSites](~~2850189~~) API to obtain this ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Site version.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'If version management is enabled for the site, use this parameter to specify the version to modify. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'title' => '规则集ID', - 'description' => 'ID of the WAF ruleset, which can be obtained by calling the [ListWafRulesets](~~2878359~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10000001', - ], + 'schema' => ['title' => '规则集ID', 'description' => 'The ID of the WAF ruleset. Call the [ListWafRulesets](~~2878359~~) API to obtain this ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000001'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], ], 'example' => '', ], @@ -29836,49 +15574,23 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], ], 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' => '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.', - ], + ['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' => '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.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\"\\n}","type":"json"}]', 'title' => 'Delete WAF Ruleset', 'changeSet' => [ - [ - 'createdAt' => '2024-09-25T07:02:51.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-25T07:02:51.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteWafRuleset', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWafRuleset'], ], ], 'ramActions' => [ @@ -29889,12 +15601,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -29902,12 +15609,8 @@ ], 'DeleteWaitingRoom' => [ 'summary' => 'Deletes a waiting room.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -29920,34 +15623,19 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239636', - 'abilityTreeNodes' => [ - 'FEATUREdcdnO4KC7Z', - ], + 'abilityTreeNodes' => ['FEATUREdcdnO4KC7Z'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'WaitingRoomId', 'in' => 'query', - 'schema' => [ - 'description' => 'The waiting room ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '25133f536f1b1f6b6091f6a92c614dd4'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The waiting room ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '25133f536f1b1f6b6091f6a92c614dd4'."\n", 'title' => ''], ], ], 'responses' => [ @@ -29955,12 +15643,7 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A123425345', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A123425345', 'title' => ''], ], 'description' => '', 'title' => '', @@ -29970,54 +15653,23 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'Site.ServiceBusy', - 'errorMessage' => 'This website is being configured. Try again later.', - 'description' => 'This website is being configured. Try again later.', - ], - [ - 'errorCode' => 'WaitingRoomRuleNotExist', - 'errorMessage' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.', - 'description' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.', - ], - [ - 'errorCode' => 'WaitingRoomEventNotExist', - 'errorMessage' => 'The waiting room event that you want to modify does not exist. Specify a valid one.', - 'description' => 'The waiting room event that you want to modify does not exist. Specify a valid one.', - ], - [ - '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' => 'The waiting room that you want to modify does not exist or does not belong to you. Confirm and try again.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Site.ServiceBusy', 'errorMessage' => 'This website is being configured. Try again later.', 'description' => 'This website is being configured. Try again later.'], + ['errorCode' => 'WaitingRoomRuleNotExist', 'errorMessage' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.', 'description' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.'], + ['errorCode' => 'WaitingRoomEventNotExist', 'errorMessage' => 'The waiting room event that you want to modify does not exist. Specify a valid one.', 'description' => 'The waiting room event that you want to modify does not exist. Specify a valid one.'], + ['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' => 'The waiting room that you want to modify does not exist or does not belong to you. Confirm and try again.'], ], 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' => '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.', - ], + ['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' => '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.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A123425345\\"\\n}","type":"json"}]', 'title' => 'DeleteWaitingRoom', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteWaitingRoom', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWaitingRoom'], ], ], 'ramActions' => [ @@ -30028,12 +15680,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -30045,12 +15692,8 @@ ], 'DeleteWaitingRoomEvent' => [ 'summary' => 'Deletes a waiting room event.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -30063,35 +15706,19 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239623', - 'abilityTreeNodes' => [ - 'FEATUREdcdnVCBH9N', - ], + 'abilityTreeNodes' => ['FEATUREdcdnVCBH9N'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'WaitingRoomEventId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the waiting room event.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '302909890***', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the waiting room event.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '302909890***', 'title' => ''], ], ], 'responses' => [ @@ -30099,12 +15726,7 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', 'title' => ''], ], 'description' => '', 'title' => '', @@ -30114,51 +15736,23 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'Site.ServiceBusy', - 'errorMessage' => 'This website is being configured. Try again later.', - 'description' => 'This website is being configured. Try again later.', - ], - [ - 'errorCode' => 'WaitingRoomRuleNotExist', - 'errorMessage' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.', - 'description' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.', - ], - [ - 'errorCode' => 'WaitingRoomEventNotExist', - 'errorMessage' => 'The waiting room event that you want to modify does not exist. Specify a valid one.', - 'description' => 'The waiting room event that you want to modify does not exist. Specify a valid one.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Site.ServiceBusy', 'errorMessage' => 'This website is being configured. Try again later.', 'description' => 'This website is being configured. Try again later.'], + ['errorCode' => 'WaitingRoomRuleNotExist', 'errorMessage' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.', 'description' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.'], + ['errorCode' => 'WaitingRoomEventNotExist', 'errorMessage' => 'The waiting room event that you want to modify does not exist. Specify a valid one.', 'description' => 'The waiting room event that you want to modify does not exist. Specify a valid one.'], ], 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' => '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.', - ], + ['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' => '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.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', 'title' => 'DeleteWaitingRoomEvent', 'changeSet' => [ - [ - 'createdAt' => '2025-02-21T03:25:57.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-02-21T03:25:57.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteWaitingRoomEvent', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWaitingRoomEvent'], ], ], 'ramActions' => [ @@ -30169,12 +15763,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -30182,12 +15771,8 @@ ], 'DeleteWaitingRoomRule' => [ 'summary' => 'Deletes a waiting room bypass rule.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -30200,35 +15785,19 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239632', - 'abilityTreeNodes' => [ - 'FEATUREdcdnA885EB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnA885EB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'WaitingRoomRuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the waiting room bypass rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '3672886****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the waiting room bypass rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '3672886****', 'title' => ''], ], ], 'responses' => [ @@ -30236,12 +15805,7 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', 'title' => ''], ], 'description' => '', 'title' => '', @@ -30251,46 +15815,22 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'Site.ServiceBusy', - 'errorMessage' => 'This website is being configured. Try again later.', - 'description' => 'This website is being configured. Try again later.', - ], - [ - 'errorCode' => 'WaitingRoomRuleNotExist', - 'errorMessage' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.', - 'description' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Site.ServiceBusy', 'errorMessage' => 'This website is being configured. Try again later.', 'description' => 'This website is being configured. Try again later.'], + ['errorCode' => 'WaitingRoomRuleNotExist', 'errorMessage' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.', 'description' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.'], ], 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' => '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.', - ], + ['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' => '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.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', 'title' => 'DeleteWaitingRoomRule', 'changeSet' => [ - [ - 'createdAt' => '2025-02-21T03:25:57.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-02-21T03:25:57.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DeleteWaitingRoomRule', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWaitingRoomRule'], ], ], 'ramActions' => [ @@ -30301,26 +15841,350 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], + ], + ], + ], + ], + 'DescribeBotPrice' => [ + 'summary' => 'Queries the price of a bot instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238935', + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], + ], + 'parameters' => [ + [ + 'name' => 'BotInstanceLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The bot instance type.', + 'enumValueTitles' => ['enterprise_bot' => 'Web edition.', 'enterprise_bot_with_app' => 'Web/App edition.'], + 'type' => 'string', + 'required' => true, + 'enum' => ['enterprise_bot', 'enterprise_bot_with_app'], + 'example' => 'enterprise_bot', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response struct.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FCF50EDF-1C2B-51E9-A372-E194D16ED350'], + 'PriceModel' => [ + 'description' => 'The price information.', + 'type' => 'object', + 'properties' => [ + 'Price' => ['description' => 'The final price of the order, which is the actual transaction price.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], + 'Currency' => ['description' => 'The currency. Valid values:'."\n" + ."\n" + .'- JPY: Japanese Yen.'."\n" + ."\n" + .'- USD: US Dollar.'."\n" + ."\n" + .'- CNY: Chinese Yuan.', 'type' => 'string', 'example' => 'CNY', 'title' => ''], + 'TotalPrice' => ['description' => 'The original price of the order. Original price = actual transaction price + discount amount.', 'type' => 'number', 'format' => 'float', 'example' => '150', 'title' => ''], + 'DiscountPrice' => ['description' => 'The discount amount of the order.', 'type' => 'number', 'format' => 'float', 'example' => '50', 'title' => ''], + 'Rule' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RuleList' => [ + 'description' => 'The rule hits.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The policy name.', 'type' => 'string', 'example' => 'Policy A', 'title' => ''], + 'RuleDescId' => ['description' => 'The policy ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['errorCode' => 'CheckPlanFailed', 'errorMessage' => 'Invalid plan name or code. Check and try again.', 'description' => 'Invalid plan name or code. Check and try again.'], + ['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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.'], + ['errorCode' => 'InvalidSiteName', 'errorMessage' => 'Invalid website name. Check and try again.', 'description' => 'Invalid website name. Check and try again.'], + ['errorCode' => 'SYSTEM.NoSpecificCodeFailed', 'errorMessage' => 'Invalid subscription duration. Check and try again.', 'description' => 'Invalid subscription duration. Check and try again.'], + ['errorCode' => 'InvalidComponent', 'errorMessage' => 'The order parameters is invalid.', 'description' => 'The order parameters is invalid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query bot instance price', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FCF50EDF-1C2B-51E9-A372-E194D16ED350\\",\\n \\"PriceModel\\": {\\n \\"Price\\": 100,\\n \\"Currency\\": \\"CNY\\",\\n \\"TotalPrice\\": 150,\\n \\"DiscountPrice\\": 50,\\n \\"Rule\\": {\\n \\"RuleList\\": [\\n {\\n \\"Name\\": \\"Policy A\\",\\n \\"RuleDescId\\": 1\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + ], + 'DescribeCacheReservePrice' => [ + 'summary' => 'Invokes DescribeCacheReservePrice to query the price of a query cache reserve instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238935', + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], + ], + 'parameters' => [ + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => 'The purchase period. Unit: months.', 'type' => 'integer', 'format' => 'int32', 'docRequired' => true, 'required' => true, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'QuotaGb', + 'in' => 'query', + 'schema' => ['description' => 'The cache reserve specification. Unit: GB.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '512000', 'title' => ''], + ], + [ + 'name' => 'CrRegion', + 'in' => 'query', + 'schema' => ['description' => 'The cache reserve region.'."\n" + ."\n" + .'- HK: Hong Kong (China)'."\n" + ."\n" + .'- CN: the Chinese mainland.', 'type' => 'string', 'required' => false, 'example' => 'HK', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response struct.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2430E05E-1340-5773-B5E1-B743929F46F2'], + 'PriceModel' => [ + 'description' => 'The price information.', + 'type' => 'object', + 'properties' => [ + 'Price' => ['description' => 'The final order price, which is the actual transaction price.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'Currency' => ['description' => 'The currency. Valid values:'."\n" + ."\n" + .'- JPY: Japanese Yen.'."\n" + ."\n" + .'- USD: US Dollar.'."\n" + ."\n" + .'- CNY: Chinese Yuan.', 'type' => 'string', 'example' => 'CNY', 'title' => ''], + 'TotalPrice' => ['description' => 'The original order price. Original order price = actual transaction price + discount amount.', 'type' => 'number', 'format' => 'float', 'example' => '2', 'title' => ''], + 'DiscountPrice' => ['description' => 'The discount amount of the order.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'Rule' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RuleList' => [ + 'description' => 'The rule hits.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The policy name.', 'type' => 'string', 'example' => 'Policy A', 'title' => ''], + 'RuleDescId' => ['description' => 'The policy ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['errorCode' => 'CheckPlanFailed', 'errorMessage' => 'Invalid plan name or code. Check and try again.', 'description' => 'Invalid plan name or code. Check and try again.'], + ['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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.'], + ['errorCode' => 'InvalidSiteName', 'errorMessage' => 'Invalid website name. Check and try again.', 'description' => 'Invalid website name. Check and try again.'], + ['errorCode' => 'SYSTEM.NoSpecificCodeFailed', 'errorMessage' => 'Invalid subscription duration. Check and try again.', 'description' => 'Invalid subscription duration. Check and try again.'], + ['errorCode' => 'InvalidComponent', 'errorMessage' => 'The order parameters is invalid.', 'description' => 'The order parameters is invalid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2430E05E-1340-5773-B5E1-B743929F46F2\\",\\n \\"PriceModel\\": {\\n \\"Price\\": 1,\\n \\"Currency\\": \\"CNY\\",\\n \\"TotalPrice\\": 2,\\n \\"DiscountPrice\\": 1,\\n \\"Rule\\": {\\n \\"RuleList\\": [\\n {\\n \\"Name\\": \\"Policy A\\",\\n \\"RuleDescId\\": 1\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Query cache reserve price', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'DescribeCustomScenePolicies' => [ - 'methods' => [ - 'get', - 'post', + 'DescribeCacheReservePriceGap' => [ + 'summary' => 'Queries the price for a cache-retained specification change.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '249936', + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'esa-cr-9tuv*********', 'title' => ''], + ], + [ + 'name' => 'TargetQuotaGb', + 'in' => 'query', + 'schema' => ['description' => 'The requested cache size. Unit: GB.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response struct.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '40423A7F-A83D-1E24-B80E-86DD25790759'."\n"], + 'PriceModel' => [ + 'description' => 'The pricing information.', + 'type' => 'object', + 'properties' => [ + 'Rule' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RuleList' => [ + 'description' => 'The rule hits.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The policy name.', 'type' => 'string', 'example' => 'rule-a', 'title' => ''], + 'RuleDescId' => ['description' => 'The policy ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'esa-cr-9tuv*********', 'title' => ''], + 'Price' => ['description' => 'The final order price, which is the actual transaction price.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'Currency' => ['description' => 'The currency. Valid values:'."\n" + .'- JPY: Japanese Yen.'."\n" + .'- USD: US Dollar.'."\n" + .'- CNY: Chinese Yuan.', 'type' => 'string', 'example' => 'CNY', 'title' => ''], + 'TotalPrice' => ['description' => 'The original order price. Original order price = actual transaction price + discount amount.', 'type' => 'number', 'format' => 'float', 'example' => '2', 'title' => ''], + 'DiscountPrice' => ['description' => 'The discount amount of the order.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['errorCode' => 'CheckPlanFailed', 'errorMessage' => 'Invalid plan name or code. Check and try again.', 'description' => 'Invalid plan name or code. Check and try again.'], + ['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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.'], + ['errorCode' => 'InvalidSiteName', 'errorMessage' => 'Invalid website name. Check and try again.', 'description' => 'Invalid website name. Check and try again.'], + ['errorCode' => 'SYSTEM.NoSpecificCodeFailed', 'errorMessage' => 'Invalid subscription duration. Check and try again.', 'description' => 'Invalid subscription duration. Check and try again.'], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.', 'description' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.'], + ['errorCode' => 'InvalidComponent', 'errorMessage' => 'The order parameters is invalid.', 'description' => 'The order parameters is invalid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40423A7F-A83D-1E24-B80E-86DD25790759\\\\n\\",\\n \\"PriceModel\\": {\\n \\"Rule\\": {\\n \\"RuleList\\": [\\n {\\n \\"Name\\": \\"rule-a\\",\\n \\"RuleDescId\\": 1\\n }\\n ]\\n },\\n \\"InstanceId\\": \\"esa-cr-9tuv*********\\",\\n \\"Price\\": 1,\\n \\"Currency\\": \\"CNY\\",\\n \\"TotalPrice\\": 2,\\n \\"DiscountPrice\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'Query cache-retained specification change price', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:DescribeCacheReservePriceGap', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeCustomScenePolicies' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -30333,172 +16197,83 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239312', - 'abilityTreeNodes' => [ - 'FEATUREdcdnL8HX1L', - ], + 'abilityTreeNodes' => ['FEATUREdcdnL8HX1L'], ], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ - 'description' => 'The number of entries per page. Default value: **10**. Valid values: **5**, **10**, or **20**.'."\n", + 'description' => 'The number of entries per page. Default value: **10**. Valid values: **5**, **10**, and **20**.', 'type' => 'integer', 'format' => 'int32', + 'default' => '10', + 'enum' => ['5', '10', '20'], 'required' => false, 'example' => '10', - 'default' => '10', - 'enum' => [ - '5', - '10', - '20', - ], 'title' => '', ], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Valid values: **1 to 100000**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100000', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number. Valid values: **1** to **100000**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PolicyId', 'in' => 'query', - 'schema' => [ - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '0', - 'example' => '1234****', - 'title' => '', - ], + 'schema' => ['description' => 'The policy ID.', 'type' => 'integer', 'format' => 'int64', 'minimum' => '0', 'required' => false, 'example' => '1234****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '85H66C7B-671A-4297-9187-2C4477247A74', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Quota' => [ - 'description' => 'The policy quota.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '85H66C7B-671A-4297-9187-2C4477247A74'], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Quota' => ['description' => 'The maximum number of policies that you can create.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'DataModule' => [ - 'description' => 'The scenario-specific policies.'."\n", + 'description' => 'The configurations of custom scene policies.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the scenario-specific policy.'."\n", + 'description' => 'A custom scene policy configuration.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the scenario-specific policy.'."\n", - 'type' => 'string', - 'example' => 'test', - 'title' => '', - ], - 'Template' => [ - 'description' => 'The name of the policy template. Valid value:'."\n" - ."\n" - .'* **promotion**: major events.'."\n", - 'type' => 'string', - 'example' => 'promotion', - 'title' => '', - ], - 'StartTime' => [ - 'description' => 'The time when the policy takes effect.'."\n" - ."\n" - .'The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-03-04T16:00:00Z', - 'title' => '', - ], - 'EndTime' => [ - 'description' => 'The time when the policy expires.'."\n" - ."\n" - .'The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-03-06T16:00:00Z'."\n", - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the policy. Valid values:'."\n" - ."\n" - .'* **Disabled**'."\n" - .'* **Pending**'."\n" - .'* **Running**'."\n" - .'* **Expired**'."\n", - 'type' => 'string', - 'example' => 'Expired', - 'title' => '', - ], + 'Name' => ['description' => 'The name of the custom scene policy.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Template' => ['description' => 'The template name. Valid value:'."\n" + ."\n" + .'- **promotion**: A major event.', 'type' => 'string', 'example' => 'promotion', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the policy.'."\n" + ."\n" + .'The time is in UTC and follows the ISO 8601 standard. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2023-03-04T16:00:00Z', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the policy.'."\n" + ."\n" + .'The time is in UTC and follows the ISO 8601 standard. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2023-03-06T16:00:00Z'."\n", 'title' => ''], + 'Status' => ['description' => 'The effective status of the policy. Valid values:'."\n" + ."\n" + .'- **disabled**: The policy is disabled.'."\n" + ."\n" + .'- **pending**: The policy is waiting to take effect.'."\n" + ."\n" + .'- **running**: The policy is in effect.'."\n" + ."\n" + .'- **expired**: The policy has expired.', 'type' => 'string', 'example' => 'Expired', 'title' => ''], 'Objects' => [ - 'description' => 'The IDs of websites that are associated with the policy.'."\n", + 'description' => 'A list of associated site IDs.'."\n" + ."\n" + .'> This field is deprecated. We recommend that you use the `SiteIds` field instead.', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the website that is associated with the policy.'."\n", - 'type' => 'string', - 'example' => '123456****', - 'title' => '', - ], + 'items' => ['description' => 'A site ID associated with the policy.', 'type' => 'string', 'example' => '123456****', 'title' => ''], 'title' => '', 'example' => '', ], - 'PolicyId' => [ - 'description' => 'The policy ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234****'."\n", - 'title' => '', - ], - 'SiteIds' => [ - 'description' => 'IDs of associated sites. Multiple site IDs are separated by commas (",").', - 'type' => 'string', - 'example' => '123456****,123457****'."\n", - 'title' => '', - ], + 'PolicyId' => ['description' => 'The policy ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234****'."\n", 'title' => ''], + 'SiteIds' => ['description' => 'A comma-separated list of site IDs associated with the policy.', 'type' => 'string', 'example' => '123456****,123457****'."\n", 'title' => ''], ], 'title' => '', 'example' => '', @@ -30513,40 +16288,21 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], 'title' => 'Query scenario-specific policies', - 'summary' => 'Query Scenario-specific policies configuration.', + 'summary' => 'Retrieves the configurations of custom scene policies.', 'changeSet' => [ - [ - 'createdAt' => '2025-06-03T09:31:40.000Z', - 'description' => 'Response parameters changed', - ], - [ - 'createdAt' => '2025-02-19T08:08:25.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-06-03T09:31:40.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-02-19T08:08:25.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DescribeCustomScenePolicies', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomScenePolicies'], ], ], 'ramActions' => [ @@ -30557,12 +16313,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -30570,15 +16321,9 @@ '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' => 'This API is used to query the DDoS attack event list.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Gets a list of DDoS attack events.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -30591,248 +16336,124 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239644', - 'abilityTreeNodes' => [ - 'FEATUREdcdnO1ZP9O', - ], + 'abilityTreeNodes' => ['FEATUREdcdnO1ZP9O'], ], 'parameters' => [ [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'The beginning of the time range to query.'."\n" - ."\n" - .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2023-02-12T15:00:00Z', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The start time of the query.'."\n" + ."\n" + .'The time must be in ISO 8601 format and in UTC. Format: `yyyy-MM-ddTHH:mm:ssZ`.', 'type' => 'string', 'required' => true, 'example' => '2023-02-12T15:00:00Z'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n" - ."\n" - .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The maximum time range is 31 days.'."\n" - ."\n" - .'If you do not configure this parameter, the current time is used as the end of the time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2023-02-22T15:59:59Z', - 'title' => '', - ], + 'schema' => ['description' => 'The end time of the query.'."\n" + ."\n" + .'The time must be in ISO 8601 format and in UTC. Format: `yyyy-MM-ddTHH:mm:ssZ`. The time range between `StartTime` and `EndTime` cannot exceed 31 days.'."\n" + ."\n" + .'If this parameter is not specified, it defaults to the current time.', 'type' => 'string', 'required' => false, 'example' => '2023-02-22T15:59:59Z', 'title' => ''], ], [ 'name' => 'EventType', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'The type of DDoS attacks to query. Valid values:'."\n" + 'description' => 'The type of DDoS attack events to query. Valid values:'."\n" ."\n" - .'* **web-cc**: web resource exhaustion attacks.'."\n" - .'* **cc**: connection flood attacks.'."\n" - .'* **traffic**: volumetric attacks.'."\n" + .'- **web-cc**: A web resource exhaustion attack.'."\n" ."\n" - .'Default value: web-cc.'."\n", + .'- **cc**: A connection-based attack.'."\n" + ."\n" + .'- **traffic**: A traffic-based attack.'."\n" + ."\n" + .'If you do not specify this parameter, the operation queries `web-cc` events by default.', 'type' => 'string', 'required' => false, + 'enum' => ['web-cc', 'cc', 'traffic'], 'example' => 'web-cc', - 'enum' => [ - 'web-cc', - 'cc', - 'traffic', - ], 'title' => '', ], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Valid values: **1** to **100000**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '100000', - 'minimum' => '1', - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number to return. Valid range: **1** to **100000**.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ - 'description' => 'The number of entries per page. Default value: **10**. Valid values: 5, 10, and 20.'."\n", + 'description' => 'The number of entries per page. Default value: **10**. Valid values: **5**, **10**, and **20**.', 'type' => 'integer', 'format' => 'int32', + 'default' => '10', + 'enum' => ['5', '10', '20'], 'required' => false, 'example' => '10', - 'default' => '10', - 'enum' => [ - '5', - '10', - '20', - ], 'title' => '', ], ], [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '1', - 'example' => '7096621098****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the site. You can obtain this ID by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '7096621098****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D73A4243-CFBD-5110-876F-09237E77ECBD', - ], - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7096621098****', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D73A4243-CFBD-5110-876F-09237E77ECBD'], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7096621098****', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'DataList' => [ - 'description' => 'The DDoS attack events.'."\n", + 'description' => 'A list of DDoS attack event details.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the DDoS attack.'."\n", + 'description' => 'Details of a DDoS attack event.', 'type' => 'object', 'properties' => [ - 'Target' => [ - 'description' => 'The attack target.'."\n", - 'type' => 'string', - 'example' => 'example.com', - 'title' => '', - ], - 'TargetId' => [ - 'description' => 'The ID of the web resource exhaustion attack target.'."\n", - 'type' => 'string', - 'example' => '000000000155****', - 'title' => '', - ], - 'StartTime' => [ - 'description' => 'The time when the DDoS attack starts.'."\n" - ."\n" - .'The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-02-12T15:00:00Z', - 'title' => '', - ], - 'EndTime' => [ - 'description' => 'The time when the DDoS attack ends.'."\n" - ."\n" - .'The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-02-12T15:59:59Z', - 'title' => '', - ], - 'EventType' => [ - 'description' => 'The type of DDoS attacks that was queried. Valid values:'."\n" - ."\n" - .'* **web-cc**: web resource exhaustion attacks.'."\n" - .'* **cc**: connection flood attacks.'."\n" - .'* **traffic**: volumetric attacks.'."\n", - 'type' => 'string', - 'example' => 'web-cc', - 'title' => '', - ], - 'Bps' => [ - 'description' => 'The peak of volumetric attacks. Unit: bit/s.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '800', - 'title' => '', - ], - 'Pps' => [ - 'description' => 'The peak of volumetric attacks. Unit: packets per second (PPS).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12000', - 'title' => '', - ], - 'Cps' => [ - 'description' => 'The peak of connection flood attacks. Unit: connections per seconds (CPS).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - 'title' => '', - ], - 'EventId' => [ - 'description' => 'The attack event ID.'."\n", - 'type' => 'string', - 'example' => 'web-cc_1', - 'title' => '', - ], - 'Qps' => [ - 'description' => 'The peak QPS of web resource exhaustion attacks.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7692', - 'title' => '', - ], - 'Coverage' => [ - 'type' => 'string', - 'description' => 'Attack area. Valid values:'."\n" - ."\n" - .'- **domestic**: the Chinese mainland only.'."\n" - .'- **global**: global.'."\n" - .'- **overseas**: global (excluding the Chinese mainland).', - 'example' => 'domestic', - 'title' => '', - ], - 'EventResult' => [ - 'type' => 'string', - 'description' => 'Event result. Valid values:'."\n" - ."\n" - .'- **clean**: Traffic scrubbing succeeded.'."\n" - .'- **ratelimit**: Throttling.'."\n" - .'- **blackhole**: Blackhole filtering.', - 'example' => 'clean', - 'title' => '', - ], + 'Target' => ['description' => 'The attack target.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'TargetId' => ['description' => 'The ID of the attack target.', 'type' => 'string', 'example' => '000000000155****', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the DDoS attack event.'."\n" + ."\n" + .'The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is in UTC.', 'type' => 'string', 'example' => '2023-02-12T15:00:00Z', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the DDoS attack event.'."\n" + ."\n" + .'The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is in UTC.', 'type' => 'string', 'example' => '2023-02-12T15:59:59Z', 'title' => ''], + 'EventType' => ['description' => 'The type of the DDoS attack event. Valid values:'."\n" + ."\n" + .'- **web-cc**: A web resource exhaustion attack.'."\n" + ."\n" + .'- **cc**: A connection-based attack.'."\n" + ."\n" + .'- **traffic**: A volumetric attack.', 'type' => 'string', 'example' => 'web-cc', 'title' => ''], + 'Bps' => ['description' => 'The peak bits per second (Bps) of a volumetric attack.', 'type' => 'integer', 'format' => 'int64', 'example' => '800', 'title' => ''], + 'Pps' => ['description' => 'The peak packets per second (Pps) of a volumetric attack.', 'type' => 'integer', 'format' => 'int64', 'example' => '12000', 'title' => ''], + 'Cps' => ['description' => 'The peak connections per second (Cps) of a connection-based attack.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''], + 'EventId' => ['description' => 'The event ID.', 'type' => 'string', 'example' => 'web-cc_1', 'title' => ''], + 'Qps' => ['description' => 'The peak queries per second (Qps) of a web resource exhaustion attack.', 'type' => 'integer', 'format' => 'int64', 'example' => '7692', 'title' => ''], + 'Coverage' => ['description' => 'The attack region. Valid values:'."\n" + ."\n" + .'- **domestic**: Chinese mainland.'."\n" + ."\n" + .'- **global**: Global.'."\n" + ."\n" + .'- **overseas**: global (excluding Chinese mainland).', 'type' => 'string', 'example' => 'domestic', 'title' => ''], + 'EventResult' => ['description' => 'The event result. Valid values:'."\n" + ."\n" + .'- **clean**: The attack was successfully cleaned.'."\n" + ."\n" + .'- **ratelimit**: Rate limiting was applied.'."\n" + ."\n" + .'- **blackhole**: Blackhole filtering was triggered.', 'type' => 'string', 'example' => 'clean', 'title' => ''], ], 'title' => '', 'example' => '', @@ -30847,38 +16468,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query the DDoS attack event list', 'changeSet' => [ - [ - 'createdAt' => '2024-11-19T03:35:35.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2024-11-19T03:35:35.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DescribeDDoSAllEventList', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDDoSAllEventList'], ], ], 'ramActions' => [ @@ -30889,12 +16492,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -30903,13 +16501,8 @@ ], 'DescribeDDoSBpsList' => [ 'summary' => 'Query DCDN DDoS user bps and pps data', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -30922,47 +16515,25 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239163', - 'abilityTreeNodes' => [ - 'FEATUREdcdnL050IJ', - ], + 'abilityTreeNodes' => ['FEATUREdcdnL050IJ'], ], 'parameters' => [ [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The start time for fetching data, in ISO8601 format, using UTC+0, formatted as: yyyy-MM-ddTHH:mm:ssZ.', - 'type' => 'string', - 'required' => true, - 'example' => '2023-05-14T17:00:00Z', - 'title' => '', - ], + 'schema' => ['description' => 'The start time for fetching data, in ISO8601 format, using UTC+0, formatted as: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => true, 'example' => '2023-05-14T17:00:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The end time for fetching data. In ISO8601 format, using UTC+0, formatted as: yyyy-MM-ddTHH:mm:ssZ.'."\n" - ."\n" - .'The end time must be later than the start time, and the span between start and end times should not exceed 31 days.', - 'type' => 'string', - 'required' => false, - 'example' => '2023-05-18T06:19:42Z', - 'title' => '', - ], + 'schema' => ['description' => 'The end time for fetching data. In ISO8601 format, using UTC+0, formatted as: yyyy-MM-ddTHH:mm:ssZ.'."\n" + ."\n" + .'The end time must be later than the start time, and the span between start and end times should not exceed 31 days.', 'type' => 'string', 'required' => false, 'example' => '2023-05-18T06:19:42Z', 'title' => ''], ], [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '1', - 'example' => '70966210986912', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '70966210986912', 'title' => ''], ], [ 'name' => 'Coverage', @@ -30977,11 +16548,7 @@ .'- global: Global.', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'domestic' => 'domestic', - 'global' => 'global', - 'overseas' => 'overseas', - ], + 'enumValueTitles' => ['domestic' => 'domestic', 'global' => 'global', 'overseas' => 'overseas'], 'example' => 'global', 'title' => '', ], @@ -30994,35 +16561,14 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792', - ], - 'DataInterval' => [ - 'description' => 'The interval between each piece of data, in seconds.'."\n" - ."\n" - .'Generated based on the interval between StartTime and EndTime: less than 1 hour, 60s; 1 hour or more but less than 1 day, 300s; 1 day or more but less than a week, 1800s; 1 week or more, 3600s.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - 'title' => '', - ], - 'StartTime' => [ - 'description' => 'The start time for fetching data. In ISO8601 format, using UTC, formatted as: YYYY-MM-DDThh:mm:ssZ.', - 'type' => 'string', - 'example' => '2023-05-14T17:00:00Z'."\n", - 'title' => '', - ], - 'EndTime' => [ - 'description' => 'The end time for fetching data. In ISO8601 format, using UTC+0, formatted as: yyyy-MM-ddTHH:mm:ssZ.'."\n" - ."\n" - .'The end time must be later than the start time, and the span between start and end times should not exceed 31 days.', - 'type' => 'string', - 'example' => '2023-05-18T06:19:42Z'."\n", - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792'], + 'DataInterval' => ['description' => 'The interval between each piece of data, in seconds.'."\n" + ."\n" + .'Generated based on the interval between StartTime and EndTime: less than 1 hour, 60s; 1 hour or more but less than 1 day, 300s; 1 day or more but less than a week, 1800s; 1 week or more, 3600s.', 'type' => 'integer', 'format' => 'int32', 'example' => '300', 'title' => ''], + 'StartTime' => ['description' => 'The start time for fetching data. In ISO8601 format, using UTC, formatted as: YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'example' => '2023-05-14T17:00:00Z'."\n", 'title' => ''], + 'EndTime' => ['description' => 'The end time for fetching data. In ISO8601 format, using UTC+0, formatted as: yyyy-MM-ddTHH:mm:ssZ.'."\n" + ."\n" + .'The end time must be later than the start time, and the span between start and end times should not exceed 31 days.', 'type' => 'string', 'example' => '2023-05-18T06:19:42Z'."\n", 'title' => ''], 'DataModule' => [ 'description' => 'A list of network bandwidth data for each time interval.', 'type' => 'array', @@ -31030,54 +16576,13 @@ 'description' => 'Network bandwidth data for each time interval.', 'type' => 'object', 'properties' => [ - 'TotalBps' => [ - 'description' => 'Total bandwidth, in bps.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000000000', - 'title' => '', - ], - 'AttackBps' => [ - 'description' => 'Attack bandwidth, in bps.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9000000000', - 'title' => '', - ], - 'NormalBps' => [ - 'description' => 'Normal business bandwidth, in bps.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000000000', - 'title' => '', - ], - 'TotalPps' => [ - 'description' => 'Total PPS.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100000000', - 'title' => '', - ], - 'AttackPps' => [ - 'description' => 'Attack PPS.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9000000', - 'title' => '', - ], - 'NormalPps' => [ - 'description' => 'Normal business PPS.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000000', - 'title' => '', - ], - 'TimeStamp' => [ - 'description' => 'The timestamp of this data, in ISO8601 format, using UTC+0, formatted as: yyyy-MM-ddTHH:mm:ssZ.', - 'type' => 'string', - 'example' => '2023-05-14T17:00:00Z', - 'title' => '', - ], + 'TotalBps' => ['description' => 'Total bandwidth, in bps.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000000000', 'title' => ''], + 'AttackBps' => ['description' => 'Attack bandwidth, in bps.', 'type' => 'integer', 'format' => 'int64', 'example' => '9000000000', 'title' => ''], + 'NormalBps' => ['description' => 'Normal business bandwidth, in bps.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000000000', 'title' => ''], + 'TotalPps' => ['description' => 'Total PPS.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000000', 'title' => ''], + 'AttackPps' => ['description' => 'Attack PPS.', 'type' => 'integer', 'format' => 'int64', 'example' => '9000000', 'title' => ''], + 'NormalPps' => ['description' => 'Normal business PPS.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000000', 'title' => ''], + 'TimeStamp' => ['description' => 'The timestamp of this data, in ISO8601 format, using UTC+0, formatted as: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2023-05-14T17:00:00Z', 'title' => ''], ], 'title' => '', 'example' => '', @@ -31094,34 +16599,19 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'Query DDoS Network Layer Data', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DescribeDDoSBpsList', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDDoSBpsList'], ], ], 'ramActions' => [ @@ -31132,27 +16622,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], ], - 'DescribeDDoSL7QpsList' => [ - 'summary' => 'DDoS Analysis Layer 7 QPS Trend Chart API', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeDDoSBpsMax' => [ + 'summary' => 'Queries the peak bits per second (BPS) and packets per second (PPS) data of DDoS attacks at the network layer.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -31164,52 +16643,194 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '239197', - 'abilityTreeNodes' => [ - 'FEATUREdcdnO1ZP9O', - ], + 'abilityTreeCode' => '239154', + 'abilityTreeNodes' => ['FEATUREdcdnL050IJ'], ], 'parameters' => [ [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'The start time of the query.'."\n" - ."\n" - .'The date format follows ISO8601 notation and uses UTC+0, formatted as yyyy-MM-ddTHH:mm:ssZ.', - 'type' => 'string', - 'required' => true, - 'example' => '2023-04-19T16:00:00Z', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'example' => '2023-02-14T17:00:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '2023-04-07T02:34:00Z', 'title' => ''], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '709662109****', 'title' => ''], + ], + [ + 'name' => 'Coverage', + 'in' => 'query', 'schema' => [ - 'description' => 'The end time of the query.'."\n" - ."\n" - .'The date format follows ISO8601 notation and uses UTC+0, formatted as yyyy-MM-ddTHH:mm:ssZ. The maximum span between the start and end times is 31 days.'."\n" - ."\n" - .'If this parameter is not set, the current time will be used as the end time of the query.', 'type' => 'string', + 'description' => '', 'required' => false, - 'example' => '2023-04-19T19:00:00Z', + 'enumValueTitles' => ['domestic' => 'domestic', 'global' => 'global', 'overseas' => 'overseas'], + 'example' => 'global', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'StartTime' => ['description' => '', 'type' => 'string', 'example' => '2023-02-14T17:00:00Z', 'title' => ''], + 'EndTime' => ['description' => '', 'type' => 'string', 'example' => '2023-04-07T02:34:00Z', 'title' => ''], + 'MaxAtkBps' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10000000000', 'title' => ''], + 'MaxAtkPps' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '100000000', 'title' => ''], + 'RequestId' => ['description' => '', 'type' => 'string', 'example' => 'A3790430-3A06-535F-A424-0998BD9A6C9F', 'title' => ''], + ], + 'example' => '', ], ], + [], + [], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeDDoSBpsMax', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StartTime\\": \\"2023-02-14T17:00:00Z\\",\\n \\"EndTime\\": \\"2023-04-07T02:34:00Z\\",\\n \\"MaxAtkBps\\": 10000000000,\\n \\"MaxAtkPps\\": 100000000,\\n \\"RequestId\\": \\"A3790430-3A06-535F-A424-0998BD9A6C9F\\"\\n}","type":"json"}]', + ], + 'DescribeDDoSEventMax' => [ + 'summary' => 'Queries the peak values of DDoS attack events within a specified time range.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RecordId', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238888', + 'abilityTreeNodes' => ['FEATUREdcdnO1ZP9O'], + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The beginning of the time range to query.'."\n" + ."\n" + .'The date is in ISO 8601 format. The time is displayed in UTC. The format is yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => true, 'example' => '2023-02-18T16:00:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query.'."\n" + ."\n" + .'The date is in ISO 8601 format. The time is displayed in UTC. The format is yyyy-MM-ddTHH:mm:ssZ. The maximum time span between the start time and end time is 31 days.'."\n" + ."\n" + .'If you do not set this parameter, the current time is used as the end time.', 'type' => 'string', 'required' => false, 'example' => '2023-04-10T02:10:10Z', 'title' => ''], + ], + [ + 'name' => 'SiteId', 'in' => 'query', + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '7096621098****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Record ID, which can be obtained by calling the [ListRecords](~~ListRecords~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '86510927836942****', 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The unique request ID generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => '18C625C0-9D8F-530B-9D1D-00F42F4156B6', 'title' => ''], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7096621098****', 'title' => ''], + 'Cps' => ['description' => 'The peak CPS of connection flood attacks.', 'type' => 'integer', 'format' => 'int64', 'example' => '101', 'title' => ''], + 'Qps' => ['description' => 'The peak QPS of web resource exhaustion attacks.', 'type' => 'integer', 'format' => 'int64', 'example' => '72431', 'title' => ''], + 'Bps' => ['description' => 'The peak BPS of volumetric attacks.', 'type' => 'integer', 'format' => 'int64', 'example' => '8445630', 'title' => ''], + 'Pps' => ['description' => 'The peak PPS of volumetric attacks.', 'type' => 'integer', 'format' => 'int64', 'example' => '30868', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'Query peak values of DDoS attack events', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18C625C0-9D8F-530B-9D1D-00F42F4156B6\\",\\n \\"SiteId\\": 0,\\n \\"Cps\\": 101,\\n \\"Qps\\": 72431,\\n \\"Bps\\": 8445630,\\n \\"Pps\\": 30868\\n}","type":"json"}]', + ], + 'DescribeDDoSL7QpsList' => [ + 'summary' => 'DDoS Analysis Layer 7 QPS Trend Chart API', + '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' => 'The start time of the query.'."\n" + ."\n" + .'The date format follows ISO8601 notation and uses UTC+0, formatted as yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => true, 'example' => '2023-04-19T16:00:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time of the query.'."\n" + ."\n" + .'The date format follows ISO8601 notation and uses UTC+0, formatted as yyyy-MM-ddTHH:mm:ssZ. The maximum span between the start and end times is 31 days.'."\n" + ."\n" + .'If this parameter is not set, the current time will be used as the end time of the query.', 'type' => 'string', 'required' => false, 'example' => '2023-04-19T19:00:00Z', 'title' => ''], + ], + [ + 'name' => 'RecordId', + 'in' => 'query', + 'schema' => ['description' => 'Record ID, which can be obtained by calling the [ListRecords](~~ListRecords~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '86510927836942****', 'title' => ''], + ], [ 'name' => 'Interval', 'in' => 'query', @@ -31221,27 +16842,14 @@ 'format' => 'int32', 'required' => true, 'example' => '300', - 'enum' => [ - '60', - '300', - '1800', - '3600', - ], + 'enum' => ['60', '300', '1800', '3600'], 'title' => '', ], ], [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '1', - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '123456****', 'title' => ''], ], ], 'responses' => [ @@ -31251,49 +16859,16 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792', - ], - 'SiteId' => [ - 'description' => 'Site ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456****'."\n", - 'title' => '', - ], - 'RecordId' => [ - 'description' => 'Record ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '86510927836942****', - 'title' => '', - ], - 'DataInterval' => [ - 'description' => 'The time granularity of the queried data, in seconds.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - 'title' => '', - ], - 'StartTime' => [ - 'description' => 'The start time of the query.'."\n" - ."\n" - .'The date format follows ISO8601 notation and uses UTC+0, formatted as yyyy-MM-ddTHH:mm:ssZ.', - 'type' => 'string', - 'example' => '2023-04-19T16:00:00Z'."\n", - 'title' => '', - ], - 'EndTime' => [ - 'description' => 'The end time of the query.'."\n" - ."\n" - .'The date format follows ISO8601 notation and uses UTC+0, formatted as yyyy-MM-ddTHH:mm:ssZ.', - 'type' => 'string', - 'example' => '2023-04-19T19:00:00Z'."\n", - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792'], + 'SiteId' => ['description' => 'Site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456****'."\n", 'title' => ''], + 'RecordId' => ['description' => 'Record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '86510927836942****', 'title' => ''], + 'DataInterval' => ['description' => 'The time granularity of the queried data, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '300', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the query.'."\n" + ."\n" + .'The date format follows ISO8601 notation and uses UTC+0, formatted as yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2023-04-19T16:00:00Z'."\n", 'title' => ''], + 'EndTime' => ['description' => 'The end time of the query.'."\n" + ."\n" + .'The date format follows ISO8601 notation and uses UTC+0, formatted as yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2023-04-19T19:00:00Z'."\n", 'title' => ''], 'DataModule' => [ 'description' => 'Application layer time trend data list.', 'type' => 'array', @@ -31301,33 +16876,10 @@ 'description' => 'Application layer time trend data.', 'type' => 'object', 'properties' => [ - 'Total' => [ - 'description' => 'Total QPS.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9', - 'title' => '', - ], - 'Attack' => [ - 'description' => 'Attack QPS.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - 'title' => '', - ], - 'Normal' => [ - 'description' => 'Normal QPS.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - 'title' => '', - ], - 'TimeStamp' => [ - 'description' => 'Data time, following ISO8601 notation and using UTC+0, formatted as yyyy-MM-ddTHH:mm:ssZ.', - 'type' => 'string', - 'example' => '2023-04-19T16:00:00Z'."\n", - 'title' => '', - ], + 'Total' => ['description' => 'Total QPS.', 'type' => 'integer', 'format' => 'int64', 'example' => '9', 'title' => ''], + 'Attack' => ['description' => 'Attack QPS.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'Normal' => ['description' => 'Normal QPS.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], + 'TimeStamp' => ['description' => 'Data time, following ISO8601 notation and using UTC+0, formatted as yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2023-04-19T16:00:00Z'."\n", 'title' => ''], ], 'title' => '', 'example' => '', @@ -31342,34 +16894,19 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'Query DDoS Application Layer Time Dimension Aggregated Statistics', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DescribeDDoSL7QpsList', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDDoSL7QpsList'], ], ], 'ramActions' => [ @@ -31380,12 +16917,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -31395,14 +16927,67 @@ 'eventNames' => [], ], ], - 'DescribeDdosMaxBurstGbps' => [ - 'summary' => 'Queries the maximum burst bandwidth for a DDoS instance in mainland China.', - 'methods' => [ - 'get', + 'DescribeDDoSOverseasAttackCount' => [ + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '262172', + 'abilityTreeNodes' => ['FEATUREdcdnL050IJ'], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '1039004047346160', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'EBCECE18-DA96-5307-8506-01E5A0E21530'], + 'TotalCount' => ['description' => 'The total number of attacks supported by the plan.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'UsedCount' => ['description' => 'The number of attacks that have been used.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query the number of DDoS attacks outside China', + 'summary' => 'Queries the number of DDoS attacks outside China.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EBCECE18-DA96-5307-8506-01E5A0E21530\\",\\n \\"TotalCount\\": 2,\\n \\"UsedCount\\": 0\\n}","type":"json"}]', + ], + 'DescribeDdosMaxBurstGbps' => [ + 'summary' => 'Queries the maximum burst bandwidth for a DDoS instance in mainland China.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -31415,21 +17000,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '254005', - 'abilityTreeNodes' => [ - 'FEATUREdcdn5DYCZJ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn5DYCZJ'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance. You can call the [ListUserRatePlanInstances](~~2852398~~) operation to obtain the instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'esa-site-a71k7bw19dz4', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the instance. You can call the [ListUserRatePlanInstances](~~2852398~~) operation to obtain the instance ID.', 'type' => 'string', 'required' => true, 'example' => 'esa-site-a71k7bw19dz4', 'title' => ''], ], ], 'responses' => [ @@ -31437,24 +17014,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'title' => '', - 'example' => 'B5D71671-B074-5702-A0F5-B923920FDDD4', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance.', - 'type' => 'string', - 'example' => 'esa-site-a71k7bw19dz4', - 'title' => '', - ], - 'MaxBurstGbps' => [ - 'description' => 'The maximum protection bandwidth of the DDoS instance within mainland China, in Gbps.', - 'type' => 'string', - 'example' => '300', - 'title' => '', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'B5D71671-B074-5702-A0F5-B923920FDDD4'], + 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'esa-site-a71k7bw19dz4', 'title' => ''], + 'MaxBurstGbps' => ['description' => 'The maximum protection bandwidth of the DDoS instance within mainland China, in Gbps.', 'type' => 'string', 'example' => '300', 'title' => ''], ], 'description' => '', 'title' => '', @@ -31464,31 +17026,13 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => '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.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter verification failed. Check your configurations and try again.', - 'description' => 'Parameter verification failed. Check your configurations and try again.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => '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.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter verification failed. Check your configurations and try again.', 'description' => 'Parameter verification failed. Check your configurations and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeDdosMaxBurstGbps', 'changeSet' => [], 'flowControl' => [ @@ -31498,13 +17042,8 @@ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B5D71671-B074-5702-A0F5-B923920FDDD4\\",\\n \\"InstanceId\\": \\"esa-site-a71k7bw19dz4\\",\\n \\"MaxBurstGbps\\": \\"300\\"\\n}","type":"json"}]', ], 'DescribeEdgeContainerAppStats' => [ - 'summary' => 'Provides monitoring data for metrics of ESA edge containers.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -31517,71 +17056,37 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '241915', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'Tenant', 'in' => 'query', - 'schema' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 't-xxxx', - 'title' => '', - ], + 'schema' => ['description' => 'The tenant.', 'type' => 'string', 'required' => false, 'example' => 't-xxxx', 'title' => ''], ], [ 'name' => 'App', 'in' => 'query', - 'schema' => [ - 'description' => 'Basic information of the application. ', - 'type' => 'string', - 'required' => true, - 'example' => 'app-xxxx', - 'title' => '', - ], + 'schema' => ['description' => 'Basic information about the application.', 'type' => 'string', 'required' => true, 'example' => 'app-xxxx', 'title' => ''], ], [ 'name' => 'Locate', 'in' => 'query', - 'schema' => [ - 'description' => 'Region. ', - 'type' => 'string', - 'required' => false, - 'example' => 'huizhou', - 'title' => '', - ], + 'schema' => ['description' => 'The region.', 'type' => 'string', 'required' => false, 'example' => 'huizhou', 'title' => ''], ], [ 'name' => 'Isp', 'in' => 'query', - 'schema' => [ - 'description' => 'Carrier. ', - 'type' => 'string', - 'required' => false, - 'example' => 'telecom,unicom,mobile', - 'title' => '', - ], + 'schema' => ['description' => 'The Internet Service Provider (ISP).', 'type' => 'string', 'required' => false, 'example' => 'telecom,unicom,mobile', 'title' => ''], ], [ 'name' => 'Fields', 'in' => 'query', 'schema' => [ - 'description' => 'Metric fields.', + 'description' => 'The metric fields.', + 'enumValueTitles' => ['container_fs_writes_bytes_avg' => 'Write IO', 'container_memory_rss' => 'Memory usage', 'container_memory_rss_quota_rate' => 'Memory usage as a percentage of the limit', 'container_cpu_usage_seconds_quota_rate' => 'CPU usage as a percentage of the limit', 'container_cpu_usage_seconds_total' => 'Number of CPU cores', 'pod_ready_rate' => 'Pod ready rate', 'container_fs_reads_bytes_avg' => 'Read IO'], 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'container_fs_writes_bytes_avg' => '', - 'container_memory_rss' => '', - 'container_memory_rss_quota_rate' => '', - 'container_cpu_usage_seconds_quota_rate' => '', - 'container_cpu_usage_seconds_total' => '', - 'pod_ready_rate' => '', - 'container_fs_reads_bytes_avg' => '', - ], 'example' => 'pod_ready_rate', 'title' => '', ], @@ -31589,145 +17094,45 @@ [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Start Time. The date format follows the ISO8601 notation and uses UTC time, formatted as yyyy-MM-ddTHH:mm:ssZ. ', - 'type' => 'string', - 'required' => false, - 'example' => '2024-09-02T15:04:05Z', - 'title' => '', - ], + 'schema' => ['description' => 'The start time. The date must be in ISO 8601 format and use UTC. The format is yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2024-09-02T15:04:05Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The end time point for retrieving data. The date format follows the ISO8601 notation and uses UTC time, formatted as yyyy-MM-ddTHH:mm:ssZ. '."\n" - .'> The end time must be later than the start time. ', - 'type' => 'string', - 'required' => false, - 'example' => '2024-09-02T16:04:05Z', - 'title' => '', - ], + 'schema' => ['description' => 'The end time to retrieve data. The date must be in ISO 8601 format and use UTC. The format is yyyy-MM-ddTHH:mm:ssZ.'."\n" + ."\n" + .'> The end time must be later than the start time.', 'type' => 'string', 'required' => false, 'example' => '2024-09-02T16:04:05Z', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'CpuUsageSecondsQuotaRateAvg' => [ - 'description' => 'Average CPU limit ratio'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.1', - 'title' => '', - ], - 'CpuUsageSecondsTotalAvg' => [ - 'description' => 'Average number of CPU cores'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '2', - 'title' => '', - ], - 'FsReadsBytesAvgAvg' => [ - 'description' => 'Average read IO'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - 'title' => '', - ], - 'FsWritesBytesAvgAvg' => [ - 'description' => 'Average write IO'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - 'title' => '', - ], - 'MemoryRssAvg' => [ - 'description' => 'Average memory usage'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.1', - 'title' => '', - ], - 'MemoryRssQuotaRateAvg' => [ - 'description' => 'Average memory limit proportion'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '1', - 'title' => '', - ], - 'PodReadyRateAvg' => [ - 'description' => 'Average PodReady rate'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - 'title' => '', - ], + 'CpuUsageSecondsQuotaRateAvg' => ['description' => 'The average CPU usage as a percentage of the limit.', 'type' => 'number', 'format' => 'double', 'example' => '0.1', 'title' => ''], + 'CpuUsageSecondsTotalAvg' => ['description' => 'Average CPU core usage, in seconds.', 'type' => 'number', 'format' => 'double', 'example' => '2', 'title' => ''], + 'FsReadsBytesAvgAvg' => ['description' => 'The average read IO.', 'type' => 'number', 'format' => 'double', 'example' => '0', 'title' => ''], + 'FsWritesBytesAvgAvg' => ['description' => 'The average write IO.', 'type' => 'number', 'format' => 'double', 'example' => '0', 'title' => ''], + 'MemoryRssAvg' => ['description' => 'The average memory usage.', 'type' => 'number', 'format' => 'double', 'example' => '0.1', 'title' => ''], + 'MemoryRssQuotaRateAvg' => ['description' => 'The average memory usage as a percentage of the limit.', 'type' => 'number', 'format' => 'double', 'example' => '1', 'title' => ''], + 'PodReadyRateAvg' => ['description' => 'The average pod ready rate.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], 'Points' => [ - 'description' => 'Time and numeric values corresponding to the columns in the chart. ', + 'description' => 'The time and value of each data point for the chart.', 'type' => 'array', 'items' => [ - 'description' => 'Numeric values and time corresponding to the columns in the chart. ', + 'description' => 'The value and time of a data point.', 'type' => 'object', 'properties' => [ - 'Time' => [ - 'description' => 'Change time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC). ', - 'type' => 'string', - 'example' => '2024-01-18T15:04:05Z', - 'title' => '', - ], - 'ContainerCpuUsageSecondsQuotaRate' => [ - 'description' => 'CPU limit ratio (%) ', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.1', - 'title' => '', - ], - 'ContainerCpuUsageSecondsTotal' => [ - 'description' => 'Number of CPU cores ', - 'type' => 'number', - 'format' => 'double', - 'example' => '2', - 'title' => '', - ], - 'ContainerFsReadsBytesAvg' => [ - 'description' => 'Read I/O ', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - 'title' => '', - ], - 'ContainerFsWritesBytesAvg' => [ - 'description' => 'Write I/O ', - 'type' => 'number', - 'format' => 'double', - 'example' => '0', - 'title' => '', - ], - 'ContainerMemoryRss' => [ - 'description' => 'Memory usage ', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.1', - 'title' => '', - ], - 'ContainerMemoryRssQuotaRate' => [ - 'description' => 'Memory limit ratio ', - 'type' => 'number', - 'format' => 'double', - 'example' => '1', - 'title' => '', - ], - 'PodReadyRate' => [ - 'description' => 'Pod ready rate ', - 'type' => 'number', - 'format' => 'double', - 'example' => '100', - 'title' => '', - ], + 'Time' => ['description' => 'The time of the data point. The format is yyyy-MM-ddTHH:mm:ssZ in UTC.', 'type' => 'string', 'example' => '2024-01-18T15:04:05Z', 'title' => ''], + 'ContainerCpuUsageSecondsQuotaRate' => ['description' => 'The CPU usage as a percentage of the limit.', 'type' => 'number', 'format' => 'double', 'example' => '0.1', 'title' => ''], + 'ContainerCpuUsageSecondsTotal' => ['description' => 'The number of CPU cores.', 'type' => 'number', 'format' => 'double', 'example' => '2', 'title' => ''], + 'ContainerFsReadsBytesAvg' => ['description' => 'The read IO.', 'type' => 'number', 'format' => 'double', 'example' => '0', 'title' => ''], + 'ContainerFsWritesBytesAvg' => ['description' => 'The write IO.', 'type' => 'number', 'format' => 'double', 'example' => '0', 'title' => ''], + 'ContainerMemoryRss' => ['description' => 'The memory usage.', 'type' => 'number', 'format' => 'double', 'example' => '0.1', 'title' => ''], + 'ContainerMemoryRssQuotaRate' => ['description' => 'The memory usage as a percentage of the limit.', 'type' => 'number', 'format' => 'double', 'example' => '1', 'title' => ''], + 'PodReadyRate' => ['description' => 'The pod ready rate.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', @@ -31735,12 +17140,7 @@ 'title' => '', 'example' => '', ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '35C66C7B-671H-4297-9187-2C4477247A78', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '35C66C7B-671H-4297-9187-2C4477247A78'], ], 'example' => '', ], @@ -31748,37 +17148,18 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The specified EndTime is invalid.', - 'description' => 'Please provide the correct end time format. The date format follows ISO8601 notation and uses UTC time. The format is: yyyy-MM-ddTHH:mm:ssZ.', - ], - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The specified StartTime parameter is invalid.', - 'description' => 'Please provide the correct start time format. The date format follows ISO8601 notation and uses UTC time in the format yyyy-MM-ddTHH:mm:ssZ.', - ], - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The specified EndTime is invalid.', 'description' => 'Please provide the correct end time format. The date format follows ISO8601 notation and uses UTC time. The format is: yyyy-MM-ddTHH:mm:ssZ.'], + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The specified StartTime parameter is invalid.', 'description' => 'Please provide the correct start time format. The date format follows ISO8601 notation and uses UTC time in the format yyyy-MM-ddTHH:mm:ssZ.'], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], ], ], - '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"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeEdgeContainerAppStats', + 'summary' => 'Retrieves monitoring data for metrics of Edge Service Agent (ESA) edge containers.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DescribeEdgeContainerAppStats', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEdgeContainerAppStats'], ], ], 'ramActions' => [ @@ -31789,27 +17170,17 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], + '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"}]', ], 'DescribeHttpDDoSAttackIntelligentProtection' => [ - 'summary' => 'Queries the configuration of smart HTTP DDoS protection for a website.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Retrieves the HTTP DDoS intelligent protection configuration, including the protection mode and protection level.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -31822,65 +17193,38 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239217', - 'abilityTreeNodes' => [ - 'FEATUREdcdnO1ZP9O', - ], + 'abilityTreeNodes' => ['FEATUREdcdnO1ZP9O'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '1', - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can obtain this ID by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '123456****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE', - ], - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456****', - 'title' => '', - ], - 'AiMode' => [ - 'description' => 'The mode of smart HTTP DDoS protection. Valid values:'."\n" - ."\n" - .'* **observe**: alert.'."\n" - .'* **defense**: block.'."\n", - 'type' => 'string', - 'example' => 'defense', - 'title' => '', - ], - 'AiTemplate' => [ - 'description' => 'The level of smart HTTP DDoS protection. Valid values:'."\n" - ."\n" - .'* **level0**: very loose.'."\n" - .'* **level30**: loose.'."\n" - .'* **level60**: normal.'."\n" - .'* **level90**: strict.'."\n", - 'type' => 'string', - 'example' => 'level60', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE'], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456****', 'title' => ''], + 'AiMode' => ['description' => 'The protection mode for HTTP DDoS intelligent protection. Valid values:'."\n" + ."\n" + .'- **observe**: Observe'."\n" + ."\n" + .'- **defense**: Defense', 'type' => 'string', 'example' => 'defense', 'title' => ''], + 'AiTemplate' => ['description' => 'The protection level for HTTP DDoS intelligent protection. Valid values:'."\n" + ."\n" + .'- **level0**: Very Loose'."\n" + ."\n" + .'- **level30**: Loose'."\n" + ."\n" + .'- **level60**: Normal'."\n" + ."\n" + .'- **level90**: Strict', 'type' => 'string', 'example' => 'level60', 'title' => ''], ], 'example' => '', ], @@ -31888,50 +17232,25 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'ErrSiteIdNoteEnterprise', - 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', - 'description' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'ErrSiteIdNoteEnterprise', 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', 'description' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.'], ], 403 => [ - [ - 'errorCode' => 'SiteIdDDoSVersionCheckFailed', - 'errorMessage' => 'SiteId DDoS version check failed.', - 'description' => 'Failed to check the DDoS version corresponding to the site.', - ], + ['errorCode' => 'SiteIdDDoSVersionCheckFailed', 'errorMessage' => 'SiteId DDoS version check failed.', 'description' => 'Failed to check the DDoS version corresponding to the site.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + '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' => 'DescribeHttpDDoSAttackIntelligentProtection', 'changeSet' => [ - [ - 'createdAt' => '2024-11-19T03:35:35.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-11-19T03:35:35.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DescribeHttpDDoSAttackIntelligentProtection', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHttpDDoSAttackIntelligentProtection'], ], ], 'ramActions' => [ @@ -31942,28 +17261,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE\\",\\n \\"SiteId\\": 0,\\n \\"AiMode\\": \\"defense\\",\\n \\"AiTemplate\\": \\"level60\\"\\n}","type":"json"}]', ], 'DescribeHttpDDoSAttackProtection' => [ 'summary' => 'Queries the configurations of HTTP DDoS attack protection.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -31976,23 +17283,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239336', - 'abilityTreeNodes' => [ - 'FEATUREdcdn5DYCZJ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn5DYCZJ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '1', - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '123456****', 'title' => ''], ], ], 'responses' => [ @@ -32002,30 +17299,14 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '35C66C7B-671H-4297-9187-2C4477247A78', - ], - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456****', - 'title' => '', - ], - 'GlobalMode' => [ - 'description' => 'The level of HTTP DDoS attack protection. Valid values:'."\n" - ."\n" - .'* **very weak**: very loose.'."\n" - .'* **weak**: loose.'."\n" - .'* **default**: normal.'."\n" - .'* **hard**: strict.'."\n", - 'type' => 'string', - 'example' => 'default', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '35C66C7B-671H-4297-9187-2C4477247A78'], + 'SiteId' => ['description' => 'The website ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123456****', 'title' => ''], + 'GlobalMode' => ['description' => 'The level of HTTP DDoS attack protection. Valid values:'."\n" + ."\n" + .'* **very weak**: very loose.'."\n" + .'* **weak**: loose.'."\n" + .'* **default**: normal.'."\n" + .'* **hard**: strict.'."\n", 'type' => 'string', 'example' => 'default', 'title' => ''], ], 'example' => '', ], @@ -32033,50 +17314,24 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'ErrSiteIdNoteEnterprise', - 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', - 'description' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'ErrSiteIdNoteEnterprise', 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', 'description' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.'], ], 403 => [ - [ - 'errorCode' => 'SiteIdDDoSVersionCheckFailed', - 'errorMessage' => 'SiteId DDoS version check failed.', - 'description' => 'Failed to check the DDoS version corresponding to the site.', - ], + ['errorCode' => 'SiteIdDDoSVersionCheckFailed', 'errorMessage' => 'SiteId DDoS version check failed.', 'description' => 'Failed to check the DDoS version corresponding to the site.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeHttpDDoSAttackProtection', 'changeSet' => [ - [ - 'createdAt' => '2024-11-19T03:35:35.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-11-19T03:35:35.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DescribeHttpDDoSAttackProtection', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHttpDDoSAttackProtection'], ], ], 'ramActions' => [ @@ -32087,12 +17342,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -32100,13 +17350,8 @@ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35C66C7B-671H-4297-9187-2C4477247A78\\",\\n \\"SiteId\\": 0,\\n \\"GlobalMode\\": \\"default\\"\\n}","type":"json"}]', ], 'DescribeHttpDDoSAttackRules' => [ - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -32119,38 +17364,19 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '263687', - 'abilityTreeNodes' => [ - 'FEATUREdcdn5DYCZJ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn5DYCZJ'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the site. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '1', - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the site. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '123456****', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The current page number. Default value: 1. Valid values: **1** to **65535**.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '10000', - 'minimum' => '1', - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The current page number. Default value: 1. Valid values: **1** to **65535**.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', @@ -32160,11 +17386,7 @@ 'type' => 'integer', 'format' => 'int32', 'default' => '10', - 'enum' => [ - '5', - '10', - '20', - ], + 'enum' => ['5', '10', '20'], 'required' => false, 'example' => '10', 'title' => '', @@ -32176,92 +17398,27 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'title' => '', - 'example' => 'D4030CD2-0D9D-5E92-B358-421AE58307C6', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - 'title' => '', - ], - 'PageNumber' => [ - 'description' => 'The current page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'D4030CD2-0D9D-5E92-B358-421AE58307C6'], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'RuleInfos' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'RuleName' => [ - 'description' => 'The name of the rule.', - 'type' => 'string', - 'example' => 'Illegal request。', - 'title' => '', - ], - 'RuleIdInfo' => [ - 'description' => 'The short name of the rule.', - 'type' => 'string', - 'example' => 'global_01_s', - 'title' => '', - ], - 'RuleDesc' => [ - 'description' => 'The description of the rule.', - 'type' => 'string', - 'example' => 'The HTTP request\'s Accept header contains invalid features#1', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the rule. Valid values:'."\n" - ."\n" - .'- **on**: The rule is enabled.'."\n" - ."\n" - .'- **off**: The rule is disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'DefaultAction' => [ - 'description' => 'The default action.', - 'type' => 'string', - 'example' => 'deny', - 'title' => '', - ], - 'Action' => [ - 'description' => 'The action to perform.', - 'type' => 'string', - 'example' => 'deny', - 'title' => '', - ], - 'RuleId' => [ - 'description' => 'The ID of the HTTP DDoS protection rule.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20203578', - 'title' => '', - ], - 'LogRuleId' => [ - 'description' => 'The ID of the protection rule used for log records.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100010', - 'title' => '', - ], + 'RuleName' => ['description' => 'The name of the rule.', 'type' => 'string', 'example' => 'Illegal request。', 'title' => ''], + 'RuleIdInfo' => ['description' => 'The short name of the rule.', 'type' => 'string', 'example' => 'global_01_s', 'title' => ''], + 'RuleDesc' => ['description' => 'The description of the rule.', 'type' => 'string', 'example' => 'The HTTP request\'s Accept header contains invalid features#1', 'title' => ''], + 'Status' => ['description' => 'The status of the rule. Valid values:'."\n" + ."\n" + .'- **on**: The rule is enabled.'."\n" + ."\n" + .'- **off**: The rule is disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'DefaultAction' => ['description' => 'The default action.', 'type' => 'string', 'example' => 'deny', 'title' => ''], + 'Action' => ['description' => 'The action to perform.', 'type' => 'string', 'example' => 'deny', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the HTTP DDoS protection rule.', 'type' => 'integer', 'format' => 'int32', 'example' => '20203578', 'title' => ''], + 'LogRuleId' => ['description' => 'The ID of the protection rule used for log records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100010', 'title' => ''], ], 'description' => '', 'title' => '', @@ -32280,30 +17437,14 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'The specified SiteId is invalid.', - 'description' => 'The specified SiteId is invalid.Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'ErrSiteIdNoteEnterprise', - 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', - 'description' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', - ], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'The specified SiteId is invalid.', 'description' => 'The specified SiteId is invalid.Check parameter SiteId and try again.'], + ['errorCode' => 'ErrSiteIdNoteEnterprise', 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', 'description' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.'], ], 403 => [ - [ - 'errorCode' => 'SiteIdDDoSVersionCheckFailed', - 'errorMessage' => 'SiteId DDoS version check failed.', - 'description' => 'Failed to check the DDoS version corresponding to the site.', - ], + ['errorCode' => 'SiteIdDDoSVersionCheckFailed', 'errorMessage' => 'SiteId DDoS version check failed.', 'description' => 'Failed to check the DDoS version corresponding to the site.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], 'title' => 'DescribeHttpDDoSAttackRules', @@ -32320,12 +17461,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -32333,13 +17469,8 @@ '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', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -32352,38 +17483,19 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '263690', - 'abilityTreeNodes' => [ - 'FEATUREdcdn5DYCZJ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn5DYCZJ'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The site ID. To obtain the site ID, call the [ListSites](~~ListSites~~) operation.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '1', - 'example' => '5407498413****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. To obtain the site ID, call the [ListSites](~~ListSites~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '5407498413****', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The current page number.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '100000', - 'minimum' => '1', - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', @@ -32394,11 +17506,7 @@ 'format' => 'int32', 'required' => false, 'default' => '10', - 'enum' => [ - '5', - '10', - '20', - ], + 'enum' => ['5', '10', '20'], 'example' => '10', 'title' => '', ], @@ -32411,9 +17519,7 @@ 'type' => 'string', 'required' => false, 'default' => 'acl', - 'enum' => [ - 'acl', - ], + 'enum' => ['acl'], 'example' => 'acl', 'title' => '', ], @@ -32424,83 +17530,22 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Id of the request', - 'type' => 'string', - 'title' => '', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - ], - 'TotalCount' => [ - 'description' => 'The total number of rules.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - 'title' => '', - ], - 'PageNumber' => [ - 'description' => 'The current page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], + 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9'], + 'TotalCount' => ['description' => 'The total number of rules.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'RuleInfos' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'RuleName' => [ - 'description' => 'The rule name.', - 'type' => 'string', - 'example' => 'smart_cc_***', - 'title' => '', - ], - 'RecordName' => [ - 'description' => 'The record name.', - 'type' => 'string', - 'example' => 'test.example.com', - 'title' => '', - ], - 'Action' => [ - 'description' => 'The protection action.', - 'type' => 'string', - 'example' => 'deny', - 'title' => '', - ], - 'RuleId' => [ - 'description' => 'The rule ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20569929', - 'title' => '', - ], - 'Condition' => [ - 'description' => 'The rule trigger condition.', - 'type' => 'string', - 'example' => '{"$and":[{"key":"URI","opValue":"prefix-match","values":"/"}]}', - 'title' => '', - ], - 'PunishTime' => [ - 'description' => 'The action duration. Unit: seconds.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1800', - 'title' => '', - ], - 'LogRuleId' => [ - 'description' => 'The ID of the protection rule for log records.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000030', - 'title' => '', - ], + 'RuleName' => ['description' => 'The rule name.', 'type' => 'string', 'example' => 'smart_cc_***', 'title' => ''], + 'RecordName' => ['description' => 'The record name.', 'type' => 'string', 'example' => 'test.example.com', 'title' => ''], + 'Action' => ['description' => 'The protection action.', 'type' => 'string', 'example' => 'deny', 'title' => ''], + 'RuleId' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '20569929', 'title' => ''], + 'Condition' => ['description' => 'The rule trigger condition.', 'type' => 'string', 'example' => '{"$and":[{"key":"URI","opValue":"prefix-match","values":"/"}]}', 'title' => ''], + 'PunishTime' => ['description' => 'The action duration. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1800', 'title' => ''], + 'LogRuleId' => ['description' => 'The ID of the protection rule for log records.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000030', 'title' => ''], ], 'description' => '', 'title' => '', @@ -32519,30 +17564,14 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'The specified SiteId is invalid.', - 'description' => 'The specified SiteId is invalid.Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'ErrSiteIdNoteEnterprise', - 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', - 'description' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', - ], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'The specified SiteId is invalid.', 'description' => 'The specified SiteId is invalid.Check parameter SiteId and try again.'], + ['errorCode' => 'ErrSiteIdNoteEnterprise', 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', 'description' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.'], ], 403 => [ - [ - 'errorCode' => 'SiteIdDDoSVersionCheckFailed', - 'errorMessage' => 'SiteId DDoS version check failed.', - 'description' => 'Failed to check the DDoS version corresponding to the site.', - ], + ['errorCode' => 'SiteIdDDoSVersionCheckFailed', 'errorMessage' => 'SiteId DDoS version check failed.', 'description' => 'Failed to check the DDoS version corresponding to the site.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], 'title' => 'DescribeHttpDDoSIntelligentAclRules', @@ -32556,13 +17585,8 @@ ], 'DescribeHttpDDoSIntelligentRateLimitRules' => [ 'summary' => 'Queries the frequency control rules generated by Deep Learning and Protection.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -32575,38 +17599,19 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '263694', - 'abilityTreeNodes' => [ - 'FEATUREdcdn5DYCZJ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn5DYCZJ'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The site ID. Obtain this by calling the [ListSites](~~2850189~~) operation.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '1', - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. Obtain this by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '123456****', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The current page number.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '100000', - 'minimum' => '1', - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', @@ -32617,11 +17622,7 @@ 'format' => 'int32', 'required' => false, 'default' => '10', - 'enum' => [ - '5', - '10', - '20', - ], + 'enum' => ['5', '10', '20'], 'example' => '10', 'title' => '', ], @@ -32634,9 +17635,7 @@ 'type' => 'string', 'required' => false, 'default' => 'cc', - 'enum' => [ - 'cc', - ], + 'enum' => ['cc'], 'example' => 'cc', 'title' => '', ], @@ -32647,95 +17646,24 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'title' => '', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], - 'TotalCount' => [ - 'description' => 'The total number of rules.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - 'title' => '', - ], - 'PageNumber' => [ - 'description' => 'The current page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], + 'TotalCount' => ['description' => 'The total number of rules.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'RuleInfos' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'RuleName' => [ - 'description' => 'The name of the rule.', - 'type' => 'string', - 'example' => 'inner_cc_client_ip_ratelimit', - 'title' => '', - ], - 'RecordName' => [ - 'description' => 'The name of the record.', - 'type' => 'string', - 'example' => 'test.example.com', - 'title' => '', - ], - 'Action' => [ - 'description' => 'The action to perform.', - 'type' => 'string', - 'example' => 'js', - 'title' => '', - ], - 'RuleId' => [ - 'description' => 'The ID of the rule.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20110849', - 'title' => '', - ], - 'RateLimit' => [ - 'description' => 'The frequency information.', - 'type' => 'string', - 'example' => '{"threshold":2000,"interval":5,"target":"ip","ttl":600}', - 'title' => '', - ], - 'Statistics' => [ - 'description' => 'The statistics.', - 'type' => 'string', - 'example' => '{"field":"ip","mode":"count"}', - 'title' => '', - ], - 'Condition' => [ - 'description' => 'The conditions that trigger the rule.', - 'type' => 'string', - 'example' => '{"$and":[{"key":"URI","opValue":"prefix-match","values":"/"}]}', - 'title' => '', - ], - 'PunishTime' => [ - 'description' => 'The duration of the penalty in seconds.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '86400', - 'title' => '', - ], - 'LogRuleId' => [ - 'description' => 'The ID of the protection rule for log records.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100030', - 'title' => '', - ], + 'RuleName' => ['description' => 'The name of the rule.', 'type' => 'string', 'example' => 'inner_cc_client_ip_ratelimit', 'title' => ''], + 'RecordName' => ['description' => 'The name of the record.', 'type' => 'string', 'example' => 'test.example.com', 'title' => ''], + 'Action' => ['description' => 'The action to perform.', 'type' => 'string', 'example' => 'js', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '20110849', 'title' => ''], + 'RateLimit' => ['description' => 'The frequency information.', 'type' => 'string', 'example' => '{"threshold":2000,"interval":5,"target":"ip","ttl":600}', 'title' => ''], + 'Statistics' => ['description' => 'The statistics.', 'type' => 'string', 'example' => '{"field":"ip","mode":"count"}', 'title' => ''], + 'Condition' => ['description' => 'The conditions that trigger the rule.', 'type' => 'string', 'example' => '{"$and":[{"key":"URI","opValue":"prefix-match","values":"/"}]}', 'title' => ''], + 'PunishTime' => ['description' => 'The duration of the penalty in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '86400', 'title' => ''], + 'LogRuleId' => ['description' => 'The ID of the protection rule for log records.', 'type' => 'integer', 'format' => 'int64', 'example' => '100030', 'title' => ''], ], 'description' => '', 'title' => '', @@ -32754,30 +17682,14 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'The specified SiteId is invalid.', - 'description' => 'The specified SiteId is invalid.Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'ErrSiteIdNoteEnterprise', - 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', - 'description' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', - ], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'The specified SiteId is invalid.', 'description' => 'The specified SiteId is invalid.Check parameter SiteId and try again.'], + ['errorCode' => 'ErrSiteIdNoteEnterprise', 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', 'description' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.'], ], 403 => [ - [ - 'errorCode' => 'SiteIdDDoSVersionCheckFailed', - 'errorMessage' => 'SiteId DDoS version check failed.', - 'description' => 'Failed to check the DDoS version corresponding to the site.', - ], + ['errorCode' => 'SiteIdDDoSVersionCheckFailed', 'errorMessage' => 'SiteId DDoS version check failed.', 'description' => 'Failed to check the DDoS version corresponding to the site.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], 'title' => 'DescribeHttpDDoSIntelligentRateLimitRules', @@ -32789,27 +17701,22 @@ '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' => [ - 'summary' => 'Queries whether Edge KV is activated in your Alibaba Cloud account.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the status of an account in the KV service.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239022', - 'abilityTreeNodes' => [ - 'FEATUREdcdnGMYWU5', - ], + 'abilityTreeNodes' => ['FEATUREdcdnGMYWU5'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [], @@ -32818,21 +17725,12 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether Edge KV is activated for the Alibaba Cloud account.'."\n" - ."\n" - .'* **online**'."\n" - .'* **offline**'."\n", - 'type' => 'string', - 'example' => 'online', - 'title' => '', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', - 'title' => '', - ], + 'Status' => ['description' => 'Account status.'."\n" + ."\n" + .'- **online**: Enabled.'."\n" + ."\n" + .'- **offline**: Disabled.', 'type' => 'string', 'example' => 'online', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', 'title' => ''], ], 'description' => '', 'title' => '', @@ -32842,110 +17740,38 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidAccount.Malformed', - 'errorMessage' => 'The specified account is invalid.', - 'description' => 'The account number is not entered correctly, for example, the input is empty.', - ], - [ - 'errorCode' => 'InvalidNameSpace.Malformed', - 'errorMessage' => 'The specified namespace is invalid.', - 'description' => 'The bucket name is entered incorrectly, such as an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.Malformed', - 'errorMessage' => 'The specified key is invalid.', - 'description' => 'Key name input error, such as entering an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.ExceedsMaximum', - 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', - 'description' => 'The length of the requested key is too large.', - ], - [ - 'errorCode' => 'InvalidValue.ExceedsMaximum', - 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', - 'description' => 'The value deposited is too large.', - ], + ['errorCode' => 'InvalidAccount.Malformed', 'errorMessage' => 'The specified account is invalid.', 'description' => 'The account number is not entered correctly, for example, the input is empty.'], + ['errorCode' => 'InvalidNameSpace.Malformed', 'errorMessage' => 'The specified namespace is invalid.', 'description' => 'The bucket name is entered incorrectly, such as an empty string.'], + ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified key is invalid.', 'description' => 'Key name input error, such as entering an empty string.'], + ['errorCode' => 'InvalidKey.ExceedsMaximum', 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', 'description' => 'The length of the requested key is too large.'], + ['errorCode' => 'InvalidValue.ExceedsMaximum', 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', 'description' => 'The value deposited is too large.'], ], 403 => [ - [ - 'errorCode' => 'InvalidKey.ExceedsCapacity', - 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', - 'description' => 'The capacity of the storage space exceeds the limit.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidParameters', - 'errorMessage' => 'The specified authentication parameters are invalid.', - 'description' => 'Authentication parameter input error.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'InvalidKey.ExceedsCapacity', 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', 'description' => 'The capacity of the storage space exceeds the limit.'], + ['errorCode' => 'Unauthorized.InvalidParameters', 'errorMessage' => 'The specified authentication parameters are invalid.', 'description' => 'Authentication parameter input error.'], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'InvalidAccount.NotFound', - 'errorMessage' => 'The specified account does not exist.', - 'description' => 'The specified account does not exist.', - ], - [ - 'errorCode' => 'InvalidNameSpace.NotFound', - 'errorMessage' => 'The specified namespace does not exist.', - 'description' => '', - ], - [ - 'errorCode' => 'InvalidKey.NotFound', - 'errorMessage' => 'The specified key does not exist.', - 'description' => 'The specified key-value pair does not exist.', - ], + ['errorCode' => 'InvalidAccount.NotFound', 'errorMessage' => 'The specified account does not exist.', 'description' => 'The specified account does not exist.'], + ['errorCode' => 'InvalidNameSpace.NotFound', 'errorMessage' => 'The specified namespace does not exist.', 'description' => ''], + ['errorCode' => 'InvalidKey.NotFound', 'errorMessage' => 'The specified key does not exist.', 'description' => 'The specified key-value pair does not exist.'], ], 406 => [ - [ - 'errorCode' => 'InvalidNameSpace.Duplicate', - 'errorMessage' => 'The specified namespace already exists.', - 'description' => 'Specified storage space', - ], - [ - 'errorCode' => 'InvalidNameSpace.QuotaFull', - 'errorMessage' => 'The maximum number of namespaces is exceeded.', - 'description' => 'The number of storage spaces exceeds the capacity limit.', - ], + ['errorCode' => 'InvalidNameSpace.Duplicate', 'errorMessage' => 'The specified namespace already exists.', 'description' => 'Specified storage space'], + ['errorCode' => 'InvalidNameSpace.QuotaFull', 'errorMessage' => 'The maximum number of namespaces is exceeded.', 'description' => 'The number of storage spaces exceeds the capacity limit.'], ], 429 => [ - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests are submitted.', - 'description' => 'Submissions are too frequent, please try again later', - ], - [ - 'errorCode' => 'TooQuickRequests', - 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', - 'description' => 'The modification or deletion of key-value pairs is too frequent.', - ], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests are submitted.', 'description' => 'Submissions are too frequent, please try again later'], + ['errorCode' => 'TooQuickRequests', 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', 'description' => 'The modification or deletion of key-value pairs is too frequent.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"online\\",\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeKvAccountStatus', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '5', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DescribeKvAccountStatus', - ], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeKvAccountStatus'], ], ], 'ramActions' => [ @@ -32956,26 +17782,16 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'operationType' => 'read', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"online\\",\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\"\\n}","type":"json"}]', ], 'DescribePreloadTasks' => [ - 'summary' => 'Queries the details of prefetch tasks by time, task status, or prefetch URL.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -32988,87 +17804,40 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239113', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4TTNAL', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4TTNAL'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID. You can call the [ListSites](~~2850189~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID. You can call the [ListSites](~~2850189~~) operation to obtain the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456789****', 'title' => ''], ], [ 'name' => 'Content', 'in' => 'query', - 'schema' => [ - 'description' => 'The content to prefetch. Exact match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://a.com/1.jpg?b=2', - 'title' => '', - ], + 'schema' => ['description' => 'The content to prefetch. Exact match is supported.', 'type' => 'string', 'required' => false, 'example' => 'http://a.com/1.jpg?b=2', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Valid values: **1** to **100000**. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100000', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number. Valid values: **1** to **100000**. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 50.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '20', - 'default' => '20', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 50.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '20', 'example' => '20', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2023-03-22T17:00:00Z', - 'title' => '', - ], + 'schema' => ['description' => 'The start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.', 'type' => 'string', 'required' => false, 'example' => '2023-03-22T17:00:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The end time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n" - ."\n" - .'> The end time must be later than the start time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2023-03-23T06:23:00Z', - 'title' => '', - ], + 'schema' => ['description' => 'The end time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n" + ."\n" + .'> The end time must be later than the start time.', 'type' => 'string', 'required' => false, 'example' => '2023-03-23T06:23:00Z', 'title' => ''], ], [ 'name' => 'Status', @@ -33076,17 +17845,15 @@ 'schema' => [ 'description' => 'The task status. Valid values:'."\n" ."\n" - .'* **Complete**: The task is complete.'."\n" - .'* **Refreshing**: The task is running.'."\n" - .'* **Failed**: The task failed.'."\n", + .'- **Complete**: The task is complete.'."\n" + ."\n" + .'- **Refreshing**: The task is running.'."\n" + ."\n" + .'- **Failed**: The task failed.', 'type' => 'string', + 'enum' => ['Refreshing', 'Complete', 'Failed'], 'required' => false, 'example' => 'Complete', - 'enum' => [ - 'Refreshing', - 'Complete', - 'Failed', - ], 'title' => '', ], ], @@ -33096,83 +17863,34 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - 'title' => '', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '83', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '83', 'title' => ''], 'Tasks' => [ - 'description' => 'The tasks.'."\n", + 'description' => 'The tasks.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The task status.'."\n" - ."\n" - .'* **Complete**: The task is complete.'."\n" - .'* **Refreshing**: The task is in progress.'."\n" - .'* **Failed**: The task failed.'."\n", - 'type' => 'string', - 'example' => 'Complete', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the task was created.'."\n", - 'type' => 'string', - 'example' => '2023-03-28 14:28:57', - 'title' => '', - ], - 'Process' => [ - 'description' => 'The progress of the task, in percentage.'."\n", - 'type' => 'string', - 'example' => '100%', - 'title' => '', - ], - 'Description' => [ - 'description' => 'The error message returned upon a prefetch task failure. Valid values:'."\n" - ."\n" - .'* **Internal Error**'."\n" - .'* **Origin Timeout**'."\n" - .'* **Origin Return StatusCode 5XX**'."\n", - 'type' => 'string', - 'example' => 'Internal Error', - 'title' => '', - ], - 'Content' => [ - 'description' => 'The prefetched content.'."\n", - 'type' => 'string', - 'example' => 'http://a.com/1.jpg?b=2', - 'title' => '', - ], - 'TaskId' => [ - 'description' => 'The ID of the queried task.'."\n", - 'type' => 'string', - 'example' => '1597854579687428', - 'title' => '', - ], + 'Status' => ['description' => 'The task status.'."\n" + ."\n" + .'- **Complete**: The task is complete.'."\n" + ."\n" + .'- **Refreshing**: The task is in progress.'."\n" + ."\n" + .'- **Failed**: The task failed.', 'type' => 'string', 'example' => 'Complete', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the task was created.', 'type' => 'string', 'example' => '2023-03-28 14:28:57', 'title' => ''], + 'Process' => ['description' => 'The progress of the task, in percentage.', 'type' => 'string', 'example' => '100%', 'title' => ''], + 'Description' => ['description' => 'The error message returned upon a prefetch task failure. Valid values:'."\n" + ."\n" + .'- **Internal Error**'."\n" + ."\n" + .'- **Origin Timeout**'."\n" + ."\n" + .'- **Origin Return StatusCode 5XX**', 'type' => 'string', 'example' => 'Internal Error', 'title' => ''], + 'Content' => ['description' => 'The prefetched content.', 'type' => 'string', 'example' => 'http://a.com/1.jpg?b=2', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the queried task.', 'type' => 'string', 'example' => '1597854579687428', 'title' => ''], ], 'description' => '', 'title' => '', @@ -33190,67 +17908,28 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingTimeParameter', - 'errorMessage' => 'The StartTime and EndTime must be both specified.', - 'description' => 'Please provide both a start time and an end time.', - ], - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], - [ - 'errorCode' => 'DomainNameOverLimit', - 'errorMessage' => 'A maximum of 500 domains are supported for each request.', - 'description' => 'Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.', - ], - [ - 'errorCode' => 'InvalidTime', - 'errorMessage' => 'The query time cannot exceed the last 3 days.', - 'description' => 'The query time cannot exceed the last 3 days.', - ], - [ - 'errorCode' => 'MissingParameter.ObjectType', - 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', - 'description' => 'Specify the ObjectType parameter.', - ], - [ - 'errorCode' => 'InvalidStationParameter', - 'errorMessage' => 'The specified Station is invalid.', - 'description' => 'The specified node parameter is invalid.', - ], - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests.Please try again later.', - 'description' => 'Requests are too frequent, please try again later.', - ], - [ - 'errorCode' => 'InvalidTaskId.Malformed', - 'errorMessage' => 'The specified taskId is invalid.', - 'description' => 'The specified task ID is invalid.', - ], - [ - 'errorCode' => 'InvalidParameters.InvalidUrls', - 'errorMessage' => 'The specified urls are invalid.', - 'description' => 'The requested URL parameter is invalid.', - ], + ['errorCode' => 'MissingTimeParameter', 'errorMessage' => 'The StartTime and EndTime must be both specified.', 'description' => 'Please provide both a start time and an end time.'], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'DomainNameOverLimit', 'errorMessage' => 'A maximum of 500 domains are supported for each request.', 'description' => 'Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.'], + ['errorCode' => 'InvalidTime', 'errorMessage' => 'The query time cannot exceed the last 3 days.', 'description' => 'The query time cannot exceed the last 3 days.'], + ['errorCode' => 'MissingParameter.ObjectType', 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', 'description' => 'Specify the ObjectType parameter.'], + ['errorCode' => 'InvalidStationParameter', 'errorMessage' => 'The specified Station is invalid.', 'description' => 'The specified node parameter is invalid.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], + ['errorCode' => 'InvalidTaskId.Malformed', 'errorMessage' => 'The specified taskId is invalid.', 'description' => 'The specified task ID is invalid.'], + ['errorCode' => 'InvalidParameters.InvalidUrls', 'errorMessage' => 'The specified urls are invalid.', 'description' => 'The requested URL parameter is invalid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - '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"}]', 'title' => 'DescribePreloadTasks', + 'summary' => 'Queries prefetch tasks by time, task status, or prefetch URL.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DescribePreloadTasks', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePreloadTasks'], ], ], 'ramActions' => [ @@ -33261,29 +17940,17 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], + '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' => 'Queries the details of purge tasks.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the execution status of refresh tasks.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -33296,137 +17963,75 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239334', - 'abilityTreeNodes' => [ - 'FEATUREdcdnBCJPGN', - 'FEATUREdcdnELTTM1', - 'FEATUREdcdnA9FG2P', - 'FEATUREdcdnRELTJV', - 'FEATUREdcdnEWYS3A', - 'FEATUREdcdn4QVGXU', - ], + 'abilityTreeNodes' => ['FEATUREdcdnBCJPGN', 'FEATUREdcdnELTTM1', 'FEATUREdcdnA9FG2P', 'FEATUREdcdnRELTJV', 'FEATUREdcdnEWYS3A', 'FEATUREdcdn4QVGXU'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID. You can call the [ListSites](~~2850189~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n" + .'>You must always specify SiteId. An error is reported if SiteId is not specified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456789****', 'title' => ''], ], [ 'name' => 'Content', 'in' => 'query', - 'schema' => [ - 'description' => 'The content to purge. Exact match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://a.com/1.jpg?b=1', - 'title' => '', - ], + 'schema' => ['description' => 'The query content. Exact match is used.', 'type' => 'string', 'required' => false, 'example' => 'http://a.com/1.jpg?b=1', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The task type. Valid values:'."\n" - ."\n" - .'* **file** (default): purges the cache by file.'."\n" - .'* **cachetag**: purges the cache by cache tag.'."\n" - .'* **directory**: purges the cache by directory.'."\n" - .'* **ignoreParams**: purges the cache by URL with specified parameters ignored.'."\n" - .'* **hostname**: purges the cache by hostname.'."\n" - .'* **purgeall**: purges all cache.'."\n", + .'- **file** (default): file refresh.'."\n" + .'- **cachetag**: cache tag refresh.'."\n" + .'- **directory**: directory refresh.'."\n" + .'- **ignoreParams**: ignore parameters refresh.'."\n" + .'- **hostname**: hostname refresh.'."\n" + .'- **purgeall**: purge all cache under the site.', + 'enumValueTitles' => ['cachetag' => 'cachetag refresh.', 'hostname' => 'hostname refresh.', 'file' => 'file refresh.', 'cachekey' => 'cachekey refresh.', 'purgeall' => 'purge all.', 'ignoreparams' => 'ignore parameters refresh.', 'directory' => 'directory refresh.'], 'type' => 'string', 'required' => false, + 'enum' => ['file', 'directory', 'ignoreparams', 'hostname', 'purgeall', 'cachetag', 'cachekey'], 'example' => 'file', - 'enum' => [ - 'file', - 'directory', - 'ignoreparams', - 'hostname', - 'purgeall', - 'cachetag', - 'cachekey', - ], 'title' => '', ], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Valid values: 1 to 100000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100000', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number to return. Valid values: **1 to 100000**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100000', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 50.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '20', - 'default' => '20', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: **20**. Maximum value: **50**. Valid values: any integer from **1** to **50**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '20', 'example' => '20', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-11-16T05:33:00Z', - 'title' => '', - ], + 'schema' => ['description' => 'The start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.', 'type' => 'string', 'required' => false, 'example' => '2022-11-16T05:33:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The end time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n" - ."\n" - .'> The end time must be later than the start time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-11-18T15:59:59Z', - 'title' => '', - ], + 'schema' => ['description' => 'The end time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.'."\n" + ."\n\n" + .'> The end time must be later than the start time.', 'type' => 'string', 'required' => false, 'example' => '2022-11-18T15:59:59Z', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ - 'description' => 'The task status. Valid values:'."\n" + 'description' => 'The task execution status. Valid values:'."\n" ."\n" - .'* **Complete**: The task is complete.'."\n" - .'* **Refreshing**: The task is in progress.'."\n" - .'* **Failed**: The task failed.'."\n", + .'- **Complete**: Completed.'."\n" + .'- **Refreshing**: Refreshing.'."\n" + .'- **Failed**: Refresh failed.', + 'enumValueTitles' => ['Refreshing' => 'Refreshing.', 'Complete' => 'Completed.', 'Failed' => 'Refresh failed.'], 'type' => 'string', + 'enum' => ['Complete', 'Refreshing', 'Failed'], 'required' => false, 'example' => 'Complete', - 'enum' => [ - 'Complete', - 'Refreshing', - 'Failed', - ], 'title' => '', ], ], @@ -33436,92 +18041,35 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A123425345', - 'title' => '', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A123425345', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], 'Tasks' => [ - 'description' => 'The tasks.'."\n", + 'description' => 'The task list.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The task status.'."\n" - ."\n" - .'* **Complete**: The task is complete.'."\n" - .'* **Refreshing**: The task is in progress.'."\n" - .'* **Failed**: The task failed.'."\n", - 'type' => 'string', - 'example' => 'Complete', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the task was created.'."\n", - 'type' => 'string', - 'example' => '2023-07-26T01:56:15Z', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The type of the purge task. Valid values:'."\n" - ."\n" - .'* **file** (default): purges the cache by file.'."\n" - .'* **cachetag**: purges the cache by cache tag.'."\n" - .'* **directory**: purges the cache by directory.'."\n" - .'* **ignoreParams**: purges the cache by URL with specified parameters ignored.'."\n" - .'* **hostname**: purges the cache by hostname.'."\n" - .'* **purgeall**: purges all cache.'."\n", - 'type' => 'string', - 'example' => 'file', - 'title' => '', - ], - 'Process' => [ - 'description' => 'The progress of the task, in percentage.'."\n", - 'type' => 'string', - 'example' => '100%', - 'title' => '', - ], - 'Description' => [ - 'description' => 'The error description returned when the purge task failed.'."\n", - 'type' => 'string', - 'example' => 'Internal Error', - 'title' => '', - ], - 'Content' => [ - 'description' => 'The purged content.'."\n", - 'type' => 'string', - 'example' => 'http://a.com/1.jpg?b=1', - 'title' => '', - ], - 'TaskId' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'string', - 'example' => '16346513304', - 'title' => '', - ], + 'Status' => ['description' => 'The status. Valid values:'."\n" + ."\n" + .'- **Complete**: Completed.'."\n" + ."\n" + .'- **Refreshing**: Refreshing.'."\n" + ."\n" + .'- **Failed**: Refresh failed.', 'type' => 'string', 'example' => 'Complete', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time in ISO 8601 format (for example, 2024-01-01T00:00:00+Z).', 'type' => 'string', 'example' => '2023-07-26T01:56:15Z', 'title' => ''], + 'Type' => ['description' => 'The refresh task type. Valid values:'."\n" + .'- **file** (default): file refresh.'."\n" + .'- **cachetag**: cache tag refresh.'."\n" + .'- **directory**: directory refresh.'."\n" + .'- **ignoreParams**: ignore parameters refresh.'."\n" + .'- **hostname**: hostname refresh.'."\n" + .'- **purgeall**: purge all cache under the site.', 'type' => 'string', 'example' => 'file', 'title' => ''], + 'Process' => ['description' => 'The task completion progress in percentage.', 'type' => 'string', 'example' => '100%', 'title' => ''], + 'Description' => ['description' => 'The error description returned when the refresh task fails.', 'type' => 'string', 'example' => 'Internal Error', 'title' => ''], + 'Content' => ['description' => 'The refresh object.', 'type' => 'string', 'example' => 'http://a.com/1.jpg?b=1', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '16346513304', 'title' => ''], ], 'description' => '', 'title' => '', @@ -33539,72 +18087,26 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingTimeParameter', - 'errorMessage' => 'The StartTime and EndTime must be both specified.', - 'description' => 'Please provide both a start time and an end time.', - ], - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], - [ - 'errorCode' => 'DomainNameOverLimit', - 'errorMessage' => 'A maximum of 500 domains are supported for each request.', - 'description' => 'Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.', - ], - [ - 'errorCode' => 'InvalidTime', - 'errorMessage' => 'The query time cannot exceed the last 3 days.', - 'description' => 'The query time cannot exceed the last 3 days.', - ], - [ - 'errorCode' => 'MissingParameter.ObjectType', - 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', - 'description' => 'Specify the ObjectType parameter.', - ], - [ - 'errorCode' => 'InvalidStationParameter', - 'errorMessage' => 'The specified Station is invalid.', - 'description' => 'The specified node parameter is invalid.', - ], - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests.Please try again later.', - 'description' => 'Requests are too frequent, please try again later.', - ], - [ - 'errorCode' => 'InvalidTaskId.Malformed', - 'errorMessage' => 'The specified taskId is invalid.', - 'description' => 'The specified task ID is invalid.', - ], - [ - 'errorCode' => 'InvalidParameters.InvalidUrls', - 'errorMessage' => 'The specified urls are invalid.', - 'description' => 'The requested URL parameter is invalid.', - ], + ['errorCode' => 'MissingTimeParameter', 'errorMessage' => 'The StartTime and EndTime must be both specified.', 'description' => 'Please provide both a start time and an end time.'], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'DomainNameOverLimit', 'errorMessage' => 'A maximum of 500 domains are supported for each request.', 'description' => 'Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.'], + ['errorCode' => 'InvalidTime', 'errorMessage' => 'The query time cannot exceed the last 3 days.', 'description' => 'The query time cannot exceed the last 3 days.'], + ['errorCode' => 'MissingParameter.ObjectType', 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', 'description' => 'Specify the ObjectType parameter.'], + ['errorCode' => 'InvalidStationParameter', 'errorMessage' => 'The specified Station is invalid.', 'description' => 'The specified node parameter is invalid.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], + ['errorCode' => 'InvalidTaskId.Malformed', 'errorMessage' => 'The specified taskId is invalid.', 'description' => 'The specified task ID is invalid.'], + ['errorCode' => 'InvalidParameters.InvalidUrls', 'errorMessage' => 'The specified urls are invalid.', 'description' => 'The requested URL parameter is invalid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', - 'title' => 'DescribePurgeTasks', + 'title' => 'Query refresh tasks', 'changeSet' => [ - [ - 'createdAt' => '2025-02-10T01:55:17.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-02-10T01:55:17.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DescribePurgeTasks', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePurgeTasks'], ], ], 'ramActions' => [ @@ -33615,12 +18117,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -33628,14 +18125,8 @@ ], 'DescribeRatePlanInstanceStatus' => [ 'summary' => 'Queries the status of an instance that uses a plan.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -33647,22 +18138,14 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239092', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID, which can be obtained by calling the [ListUserRatePlanInstances](~~ListUserRatePlanInstances~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xcdn-91fknmb80f0g***', - 'title' => '', - ], + 'schema' => ['description' => 'The instance ID, which can be obtained by calling the [ListUserRatePlanInstances](~~ListUserRatePlanInstances~~) operation.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xcdn-91fknmb80f0g***', 'title' => ''], ], ], 'responses' => [ @@ -33672,32 +18155,17 @@ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '60423A7F-A83D-1E24-B80E-86DD25790759', - ], - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'example' => 'xcdn-91fknmb80f0g***'."\n", - 'title' => '', - ], - 'InstanceStatus' => [ - 'description' => 'The instance status. Valid values:'."\n" - ."\n" - .'* running: The instance is running.'."\n" - .'* renewing: The instance is being renewed.'."\n" - .'* upgrading: The configuration of the instance is being upgraded.'."\n" - .'* releasePrepaidService: The instance is released due to expiration.'."\n" - .'* creating: The instance is being created.'."\n" - .'* downgrading: The configuration of the instance is being downgraded.'."\n" - .'* ceasePrepaidService: The instance has expired.'."\n", - 'type' => 'string', - 'example' => 'running', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '60423A7F-A83D-1E24-B80E-86DD25790759'], + 'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'xcdn-91fknmb80f0g***'."\n", 'title' => ''], + 'InstanceStatus' => ['description' => 'The instance status. Valid values:'."\n" + ."\n" + .'* running: The instance is running.'."\n" + .'* renewing: The instance is being renewed.'."\n" + .'* upgrading: The configuration of the instance is being upgraded.'."\n" + .'* releasePrepaidService: The instance is released due to expiration.'."\n" + .'* creating: The instance is being created.'."\n" + .'* downgrading: The configuration of the instance is being downgraded.'."\n" + .'* ceasePrepaidService: The instance has expired.'."\n", 'type' => 'string', 'example' => 'running', 'title' => ''], ], 'example' => '', ], @@ -33705,33 +18173,18 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.', - 'description' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.', 'description' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"60423A7F-A83D-1E24-B80E-86DD25790759\\",\\n \\"InstanceId\\": \\"xcdn-91fknmb80f0g***\\\\n\\",\\n \\"InstanceStatus\\": \\"running\\"\\n}","type":"json"}]', 'title' => 'DescribeRatePlanInstanceStatus', 'description' => 'You can query the status of an instance after you purchase a plan for the instance.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DescribeRatePlanInstanceStatus', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRatePlanInstanceStatus'], ], ], 'ramActions' => [ @@ -33742,232 +18195,155 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], - 'DescribeSiteLogs' => [ - 'summary' => 'Queries the URLs from which you can download the raw access logs of a website.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeRatePlanPrice' => [ + 'summary' => 'Queries the price of a plan, including its type and status.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '238778', - 'abilityTreeNodes' => [ - 'FEATUREdcdnGVXOQA', - ], + 'abilityTreeCode' => '239601', + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ - 'name' => 'SiteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the website. You can call the ListSites operation to obtain.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456***', - 'title' => '', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 300. Valid values: 1 to 1000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '1000', - 'default' => '300', - 'example' => '10', - 'title' => '', - ], - ], - [ - 'name' => 'PageNumber', + 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'default' => '1', - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The purchase duration, in months.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'PlanName', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n" - ."\n" - .'The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-11-06T16:00:00Z', - 'title' => '', - ], + 'schema' => ['description' => 'The plan name.', 'type' => 'string', 'required' => false, 'example' => 'basic', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'Amount', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n" - ."\n" - .'The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n" - ."\n" - .'> The end time must be later than the start time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-11-06T17:00:00Z', - 'title' => '', - ], + 'schema' => ['description' => 'The number of plans.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '99', 'minimum' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - ], - 'SiteLogDetails' => [ - 'description' => 'The information about the website log files.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com', - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456***', - 'title' => '', - ], - 'LogCount' => [ - 'description' => 'The total number of entries returned on the current page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - 'title' => '', - ], - 'LogInfos' => [ - 'description' => 'The details of the website log files.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The download URL of the log file.'."\n", - 'type' => 'object', - 'properties' => [ - 'LogSize' => [ - 'description' => 'The size of the log file. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '438304768', - 'title' => '', - ], - 'EndTime' => [ - 'description' => 'The end time.'."\n", - 'type' => 'string', - 'example' => '2022-11-06T17:00:00Z'."\n", - 'title' => '', - ], - 'LogName' => [ - 'description' => 'The name of the log file.'."\n", - 'type' => 'string', - 'example' => 'example.com_2022_11_07_000000_020000.gz.xxxxxx', - 'title' => '', - ], - 'LogPath' => [ - 'description' => 'The log path.'."\n" + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '50423A7F-A83D-1E24-B80E-86DD25790759'], + 'PriceModel' => [ + 'description' => 'The pricing information.', + 'type' => 'object', + 'properties' => [ + 'RatePlan' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PlanPriceList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PlanName' => ['description' => 'The name of the plan.', 'type' => 'string', 'example' => 'basic', 'title' => ''], + 'PlanType' => ['description' => 'The type of the plan. Valid values:'."\n" ."\n" - .'> Take note of the Expires field (expiration timestamp) in this parameter. If the log download URL expires, you must reobtain the URL.'."\n", - '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", - 'title' => '', - ], - 'StartTime' => [ - 'description' => 'The create time.'."\n", - 'type' => 'string', - 'example' => '2022-11-06T16:00:00Z'."\n", - 'title' => '', + .'- **normal**: Fixed plan.'."\n" + ."\n" + .'- **enterprise**: Enterprise plan.', 'type' => 'string', 'example' => 'normal', 'title' => ''], + 'PlanStatus' => ['description' => 'The status of the plan. Valid values:'."\n" + ."\n" + .'- **uncustomed**: Not customized.'."\n" + ."\n" + .'- **upgrading**: Upgrading.'."\n" + ."\n" + .'- **unsaled**: Not purchased.'."\n" + ."\n" + .'- **saled**: Purchased.', 'type' => 'string', 'example' => 'unsaled', 'title' => ''], + 'Currency' => ['description' => 'The currency. Valid values:'."\n" + ."\n" + .'- **JPY**: Japanese yen.'."\n" + ."\n" + .'- **USD**: US dollar.'."\n" + ."\n" + .'- **CNY**: Chinese yuan.', 'type' => 'string', 'example' => 'CNY', 'title' => ''], + 'TotalPrice' => ['description' => 'The original price of the order. The value is the sum of the transaction price and the discount amount.', 'type' => 'number', 'format' => 'float', 'example' => '2', 'title' => ''], + 'DiscountPrice' => ['description' => 'The discount amount for the order.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'Price' => ['description' => 'The final price of the order.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'Coverages' => ['description' => 'The acceleration regions that are supported by the plan.', 'type' => 'string', 'example' => 'overseas,global,domestic', 'title' => ''], + 'Position' => ['description' => 'The priority of the plan.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ChargeType' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- **PREPAY**: subscription.'."\n" + ."\n" + .'- **POSTPAY**: pay-as-you-go.', 'type' => 'string', 'example' => 'PREPAY', 'title' => ''], + 'PlanTraffic' => ['description' => 'The capacity of the plan.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'EdgeCompute' => ['description' => 'Edge computing.', 'type' => 'string', 'example' => 'er_on', 'title' => ''], + 'EdgeWaf' => ['description' => 'Edge WAF.', 'type' => 'string', 'example' => 'waf_off', 'title' => ''], + 'DcdnPlan' => ['description' => 'The edition of the plan.', 'type' => 'string', 'example' => 'basicplan', 'title' => ''], + 'AccelerateType' => ['description' => 'The acceleration type.', 'type' => 'string', 'example' => 'smartrouting_off', 'title' => ''], + 'EdgeDdos7Layer' => ['description' => 'Layer 7 edge DDoS.', 'type' => 'string', 'example' => 'ddos_off', 'title' => ''], + 'Layer4Traffic' => ['description' => 'The capacity for Layer 4 acceleration.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'EdgeDdos4Layer' => ['description' => 'Layer 4 edge DDoS.', 'type' => 'string', 'example' => 'ddos_off', 'title' => ''], + 'CrossborderTraffic' => ['description' => 'China network optimization.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'EdgeLb7Layer' => ['description' => 'Layer 7 load balancing.', 'type' => 'string', 'example' => 'lb_off', 'title' => ''], + 'EdgeLb4Layer' => ['description' => 'Layer 4 load balancing.', 'type' => 'string', 'example' => 'lb_off', 'title' => ''], + 'Layer4TrafficIntl' => ['description' => 'The capacity for Layer 4 acceleration outside the Chinese mainland.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'EdgeDdos4LayerIntl' => ['description' => 'Layer 4 edge DDoS outside the Chinese mainland.', 'type' => 'string', 'example' => 'ddos_off', 'title' => ''], + 'EdgeLb4LayerIntl' => ['description' => 'Layer 4 load balancing outside the Chinese mainland.', 'type' => 'string', 'example' => 'lb_off', 'title' => ''], + 'EdgeDdosInstanceCn' => ['description' => 'The DDoS instance in the Chinese mainland.', 'type' => 'string', 'example' => 'cn_300', 'title' => ''], + 'EdgeDdosInstanceIntl' => ['description' => 'The DDoS instance outside the Chinese mainland.', 'type' => 'string', 'example' => 'overseas_300', 'title' => ''], + 'EdgeWafInstance' => ['description' => 'The WAF instance.', 'type' => 'string', 'example' => 'enterprise_bot', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => 'The price information of the plan.', 'title' => '', 'example' => '', ], - 'title' => '', - 'example' => '', ], - 'PageInfos' => [ - 'description' => 'Pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: **300**. Valid values: **1 to 1000**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '47', - 'title' => '', - ], - 'PageIndex' => [ - 'description' => 'The page number returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Rule' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RuleList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the policy.', 'type' => 'string', 'example' => 'Policy A', 'title' => ''], + 'RuleDescId' => ['description' => 'The ID of the policy.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'description' => '', 'title' => '', + 'example' => '', ], + 'description' => 'The matched policy.', + 'title' => '', + 'example' => '', ], - 'title' => '', - 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'description' => '', - 'title' => '', - 'example' => '', ], 'title' => '', 'example' => '', @@ -33979,212 +18355,426 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], - [ - 'errorCode' => 'InvalidStartTime.ValueNotSupported', - 'errorMessage' => 'The StartTime cannot exceed 31 days before the current time.', - 'description' => 'The request parameter StartTime cannot be 31 days less than the current time.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['errorCode' => 'CheckPlanFailed', 'errorMessage' => 'Invalid plan name or code. Check and try again.', 'description' => 'Invalid plan name or code. Check and try again.'], + ['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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.'], + ['errorCode' => 'InvalidSiteName', 'errorMessage' => 'Invalid website name. Check and try again.', 'description' => 'Invalid website name. Check and try again.'], + ['errorCode' => 'SYSTEM.NoSpecificCodeFailed', 'errorMessage' => 'Invalid subscription duration. Check and try again.', 'description' => 'Invalid subscription duration. Check and try again.'], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.', 'description' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.'], + ['errorCode' => 'InvalidComponent', 'errorMessage' => 'The order parameters is invalid.', 'description' => 'The order parameters is invalid.'], + ['errorCode' => 'EnterpriseAmountErr', 'errorMessage' => 'Enterprise plans do not support bulk purchase.', 'description' => 'Enterprise plans do not support bulk purchase.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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"}]', - 'title' => 'DescribeSiteLogs', - 'description' => '- 当您不指定StartTime和EndTime时，默认读取过去24小时的日志数据；当指定StartTime和EndTime时，按指定的起止时间查询日志。'."\n" - .'- 查询数据的时间粒度为一小时。'."\n" - .'- 单用户调用频率：50次/秒。'."\n" - .'- 仅支持查询最近一个月的日志记录（开始时间和当前时间跨度不大于31天）。', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"50423A7F-A83D-1E24-B80E-86DD25790759\\",\\n \\"PriceModel\\": {\\n \\"RatePlan\\": {\\n \\"PlanPriceList\\": [\\n {\\n \\"PlanName\\": \\"basic\\",\\n \\"PlanType\\": \\"normal\\",\\n \\"PlanStatus\\": \\"unsaled\\",\\n \\"Currency\\": \\"CNY\\",\\n \\"TotalPrice\\": 2,\\n \\"DiscountPrice\\": 1,\\n \\"Price\\": 1,\\n \\"Coverages\\": \\"overseas,global,domestic\\",\\n \\"Position\\": 1,\\n \\"ChargeType\\": \\"PREPAY\\",\\n \\"PlanTraffic\\": \\"1000\\",\\n \\"EdgeCompute\\": \\"er_on\\",\\n \\"EdgeWaf\\": \\"waf_off\\",\\n \\"DcdnPlan\\": \\"basicplan\\",\\n \\"AccelerateType\\": \\"smartrouting_off\\",\\n \\"EdgeDdos7Layer\\": \\"ddos_off\\",\\n \\"Layer4Traffic\\": \\"1000\\",\\n \\"EdgeDdos4Layer\\": \\"ddos_off\\",\\n \\"CrossborderTraffic\\": \\"1000\\",\\n \\"EdgeLb7Layer\\": \\"lb_off\\",\\n \\"EdgeLb4Layer\\": \\"lb_off\\",\\n \\"Layer4TrafficIntl\\": \\"1000\\",\\n \\"EdgeDdos4LayerIntl\\": \\"ddos_off\\",\\n \\"EdgeLb4LayerIntl\\": \\"lb_off\\",\\n \\"EdgeDdosInstanceCn\\": \\"cn_300\\",\\n \\"EdgeDdosInstanceIntl\\": \\"overseas_300\\",\\n \\"EdgeWafInstance\\": \\"enterprise_bot\\"\\n }\\n ]\\n },\\n \\"Rule\\": {\\n \\"RuleList\\": [\\n {\\n \\"Name\\": \\"Policy A\\",\\n \\"RuleDescId\\": 1\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => 'DescribeRatePlanPrice', + 'description' => 'The purchase period is measured in months.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ - 'operationType' => 'none', + 'operationType' => 'create', 'ramAction' => [ - 'action' => 'esa:DescribeSiteLogs', - 'authLevel' => 'resource', + 'action' => 'esa:DescribeRatePlanPrice', + 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], ], - 'DescribeSiteTimeSeriesData' => [ - 'summary' => 'Query traffic analysis time series data', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DescribeRatePlanPriceGap' => [ + 'summary' => 'Queries the price difference for a plan specification change by calling DescribeRatePlanPriceGap.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '239272', - 'abilityTreeNodes' => [ - 'FEATUREdcdnVIK4DM', - 'FEATUREdcdn2Z4HOI', - ], + 'abilityTreeCode' => '239592', + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ - 'name' => 'SiteId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID. Obtain the site ID by calling the [ListSites](~~ListSites~~) interface.'."\n" - ."\n" - .'If this parameter is empty, user-level data will be queried.', - 'type' => 'string', - 'required' => false, - 'example' => '1150376036*****', - 'title' => '', - ], + 'schema' => ['description' => 'The target plan name. You can obtain this value from the [DescribeRatePlanPrice](~~DescribeRatePlanPrice~~) operation.', 'type' => 'string', 'required' => false, 'example' => 'entranceplan', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'TargetPlanCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The start time for obtaining data.'."\n" - ."\n" - .'The date format follows ISO8601 notation and uses UTC+0 time, in the format yyyy-MM-ddTHH:mm:ssZ.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2023-04-08T16:00:00Z', - 'title' => '', - ], + 'schema' => ['description' => 'The code of the target plan for the specification change.', 'type' => 'string', 'required' => false, 'example' => 'standardplan', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'OrderType', 'in' => 'query', 'schema' => [ - 'description' => 'The end time for obtaining data.'."\n" - ."\n" - .'The date format follows ISO8601 notation and uses UTC+0 time, in the format yyyy-MM-ddTHH:mm:ssZ.'."\n" - ."\n" - .'> The end time must be later than the start time.', + 'description' => 'The specification change type. Valid values:'."\n" + .'- DOWNGRADE: downgrade.'."\n" + .'- UPGRADE: upgrade.', + 'enumValueTitles' => ['UPGRADE' => 'Upgrade.'], 'type' => 'string', + 'enum' => ['UPGRADE'], 'required' => false, - 'example' => '2023-04-09T16:00:00Z', + 'example' => 'UPGRADE', 'title' => '', ], ], [ - 'name' => 'Interval', + 'name' => 'TargetPlanName', 'in' => 'query', - 'schema' => [ - 'description' => 'The time granularity for querying data, in seconds.'."\n" - ."\n" - .'Depending on the maximum time span of a single query, this parameter supports values of 60 (1 minute), 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). For details, see the **Supported Query Time Granularities**.', - 'type' => 'string', - 'required' => false, - 'example' => '300', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the target plan for the specification change.', 'type' => 'string', 'required' => false, 'example' => 'entranceplan', 'title' => ''], ], - [ - 'name' => 'Fields', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Query metrics.', - 'type' => 'array', - 'items' => [ - 'description' => 'Query metrics.', - 'type' => 'object', - 'properties' => [ - 'FieldName' => [ - 'description' => 'Query metric value.'."\n" - ."\n" - .'> For specific dimensions, see [Data Analysis Field Description](~~2878520~~).', - 'type' => 'string', - 'required' => false, - 'example' => 'Traffic', - 'title' => '', - ], - 'Dimension' => [ - 'description' => 'Query dimension.', - 'type' => 'array', - 'items' => [ - 'description' => 'Query dimension.'."\n" - ."\n" - .'> For specific dimensions, see [Data Analysis Field Description](~~2878520~~).', - 'type' => 'string', - 'required' => false, - 'example' => 'ALL', + 'title' => '', + 'description' => 'The response struct.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '40423A7F-A83D-1E24-B80E-86DD25790759'], + 'PriceModel' => [ + 'description' => 'The price information.', + 'type' => 'object', + 'properties' => [ + 'Rule' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RuleList' => [ + 'description' => 'The rule hits.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The policy name.', 'type' => 'string', 'example' => 'Policy A', 'title' => ''], + 'RuleDescId' => ['description' => 'The policy ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', 'title' => '', + 'example' => '', ], - 'required' => false, - 'title' => '', - 'example' => '', + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'xcdn-91fknmb80f0g', 'title' => ''], + 'TargetPlanCode' => ['description' => 'The target plan code.', 'type' => 'string', 'example' => 'entranceplan', 'title' => ''], + 'Price' => ['description' => 'The final order price, which is the actual transaction price.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'Currency' => ['description' => 'The currency. Valid values:'."\n" + .'- JPY: Japanese Yen.'."\n" + .'- USD: US Dollar.'."\n" + .'- CNY: Chinese Yuan.', 'type' => 'string', 'example' => 'CNY', 'title' => ''], + 'TotalPrice' => ['description' => 'The original order price. Original order price = actual transaction price + discount amount.', 'type' => 'number', 'format' => 'float', 'example' => '2', 'title' => ''], + 'DiscountPrice' => ['description' => 'The discount amount of the order.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'required' => false, - 'title' => '', - 'example' => '', ], - 'required' => true, - 'title' => '', 'example' => '', ], ], ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['errorCode' => 'CheckPlanFailed', 'errorMessage' => 'Invalid plan name or code. Check and try again.', 'description' => 'Invalid plan name or code. Check and try again.'], + ['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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.'], + ['errorCode' => 'InvalidSiteName', 'errorMessage' => 'Invalid website name. Check and try again.', 'description' => 'Invalid website name. Check and try again.'], + ['errorCode' => 'SYSTEM.NoSpecificCodeFailed', 'errorMessage' => 'Invalid subscription duration. Check and try again.', 'description' => 'Invalid subscription duration. Check and try again.'], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.', 'description' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.'], + ['errorCode' => 'InvalidComponent', 'errorMessage' => 'The order parameters is invalid.', 'description' => 'The order parameters is invalid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40423A7F-A83D-1E24-B80E-86DD25790759\\",\\n \\"PriceModel\\": {\\n \\"Rule\\": {\\n \\"RuleList\\": [\\n {\\n \\"Name\\": \\"Policy A\\",\\n \\"RuleDescId\\": 1\\n }\\n ]\\n },\\n \\"InstanceId\\": \\"xcdn-91fknmb80f0g\\",\\n \\"TargetPlanCode\\": \\"entranceplan\\",\\n \\"Price\\": 1,\\n \\"Currency\\": \\"CNY\\",\\n \\"TotalPrice\\": 2,\\n \\"DiscountPrice\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'Query plan specification change price difference', + 'description' => 'The plan name and plan code can be obtained from the [DescribeRatePlanPrice](~~DescribeRatePlanPrice~~) operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:DescribeRatePlanPriceGap', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + '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' => 'The ID of the website. You can call the ListSites operation to obtain.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456***', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The number of entries per page. Default value: 300. Valid values: 1 to 1000.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '1000', 'default' => '300', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from page 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query.'."\n" + ."\n" + .'The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'required' => false, 'example' => '2022-11-06T16:00:00Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query.'."\n" + ."\n" + .'The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n" + ."\n" + .'> The end time must be later than the start time.', 'type' => 'string', 'required' => false, 'example' => '2022-11-06T17:00:00Z', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'Returned data.', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9'], + 'SiteLogDetails' => [ + 'description' => 'The information about the website log files.', 'type' => 'array', 'items' => [ - 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ - 'FieldName' => [ - 'description' => 'Query metric value.', - 'type' => 'string', - 'example' => 'Traffic', - 'title' => '', - ], - 'DimensionName' => [ - 'description' => 'Query dimension.', - 'type' => 'string', - 'example' => 'ALL', + 'SiteName' => ['description' => 'The website name.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'SiteId' => ['description' => 'The website ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456***', 'title' => ''], + 'LogCount' => ['description' => 'The total number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '300', 'title' => ''], + 'LogInfos' => [ + 'description' => 'The details of the website log files.', + 'type' => 'array', + 'items' => [ + 'description' => 'The download URL of the log file.', + 'type' => 'object', + 'properties' => [ + 'LogSize' => ['description' => 'The size of the log file. Unit: bytes.', 'type' => 'integer', 'format' => 'int32', 'example' => '438304768', 'title' => ''], + 'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2022-11-06T17:00:00Z'."\n", 'title' => ''], + 'LogName' => ['description' => 'The name of the log file.', 'type' => 'string', 'example' => 'example.com_2022_11_07_000000_020000.gz.xxxxxx', 'title' => ''], + 'LogPath' => ['description' => 'The log path.'."\n" + ."\n" + .'> Take note of the Expires field (expiration timestamp) in this parameter. If the log download URL expires, you must reobtain the URL.', '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", 'title' => ''], + 'StartTime' => ['description' => 'The create time.', 'type' => 'string', 'example' => '2022-11-06T16:00:00Z'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], 'title' => '', + 'example' => '', ], - 'DimensionValue' => [ - 'description' => 'Query dimension value.', - 'type' => 'string', - 'example' => 'ALL', + 'PageInfos' => [ + 'description' => 'Pagination information.', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['description' => 'The number of entries per page. Default value: **300**. Valid values: **1 to 1000**.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '47', 'title' => ''], + 'PageIndex' => ['description' => 'The page number returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], 'title' => '', + 'example' => '', ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'InvalidStartTime.ValueNotSupported', 'errorMessage' => 'The StartTime cannot exceed 31 days before the current time.', 'description' => 'The request parameter StartTime cannot be 31 days less than the current time.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'DescribeSiteLogs', + 'summary' => 'Queries the URLs from which you can download the raw access logs of a website.', + 'description' => '- If you do not specify StartTime and EndTime, log data from the last 24 hours is returned by default. If you specify StartTime and EndTime, log data for the specified time range is returned.'."\n" + ."\n" + .'- The time granularity for data queries is one hour.'."\n" + ."\n" + .'- The maximum number of calls per user: 50 calls per second.'."\n" + ."\n" + .'- Only log records from the last month can be queried (the time span between the start time and the current time cannot exceed 31 days).', + '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' => 'Query traffic analysis time series data', + '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' => 'Site ID. Obtain the site ID by calling the [ListSites](~~ListSites~~) interface.'."\n" + ."\n" + .'If this parameter is empty, user-level data will be queried.', 'type' => 'string', 'required' => false, 'example' => '1150376036*****', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time for obtaining data.'."\n" + ."\n" + .'The date format follows ISO8601 notation and uses UTC+0 time, in the format yyyy-MM-ddTHH:mm:ssZ.'."\n", 'type' => 'string', 'required' => false, 'example' => '2023-04-08T16:00:00Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time for obtaining data.'."\n" + ."\n" + .'The date format follows ISO8601 notation and uses UTC+0 time, in the format yyyy-MM-ddTHH:mm:ssZ.'."\n" + ."\n" + .'> The end time must be later than the start time.', 'type' => 'string', 'required' => false, 'example' => '2023-04-09T16:00:00Z', 'title' => ''], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => ['description' => 'The time granularity for querying data, in seconds.'."\n" + ."\n" + .'Depending on the maximum time span of a single query, this parameter supports values of 60 (1 minute), 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). For details, see the **Supported Query Time Granularities**.', 'type' => 'string', 'required' => false, 'example' => '300', 'title' => ''], + ], + [ + 'name' => 'Fields', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Query metrics.', + 'type' => 'array', + 'items' => [ + 'description' => 'Query metrics.', + 'type' => 'object', + 'properties' => [ + 'FieldName' => ['description' => 'Query metric value.'."\n" + ."\n" + .'> For specific dimensions, see [Data Analysis Field Description](~~2878520~~).', 'type' => 'string', 'required' => false, 'example' => 'Traffic', 'title' => ''], + 'Dimension' => [ + 'description' => 'Query dimension.', + 'type' => 'array', + 'items' => ['description' => 'Query dimension.'."\n" + ."\n" + .'> For specific dimensions, see [Data Analysis Field Description](~~2878520~~).', 'type' => 'string', 'required' => false, 'example' => 'ALL', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'Returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'Returned data.', + 'type' => 'object', + 'properties' => [ + 'FieldName' => ['description' => 'Query metric value.', 'type' => 'string', 'example' => 'Traffic', 'title' => ''], + 'DimensionName' => ['description' => 'Query dimension.', 'type' => 'string', 'example' => 'ALL', 'title' => ''], + 'DimensionValue' => ['description' => 'Query dimension value.', 'type' => 'string', 'example' => 'ALL', 'title' => ''], 'DetailData' => [ 'description' => 'Returned data.', 'type' => 'array', @@ -34192,18 +18782,8 @@ 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ - 'TimeStamp' => [ - 'description' => 'Start timestamp of the time slice.', - 'type' => 'string', - 'example' => '2023-04-08T16:00:00Z', - 'title' => '', - ], - 'Value' => [ - 'description' => 'Value.', - 'type' => 'any', - 'example' => '123', - 'title' => '', - ], + 'TimeStamp' => ['description' => 'Start timestamp of the time slice.', 'type' => 'string', 'example' => '2023-04-08T16:00:00Z', 'title' => ''], + 'Value' => ['description' => 'Value.', 'type' => 'any', 'example' => '123', 'title' => ''], ], 'title' => '', 'example' => '', @@ -34224,36 +18804,11 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'FieldName' => [ - 'description' => 'The value of the aggregated metric being queried.', - 'type' => 'string', - 'example' => 'Traffic', - 'title' => '', - ], - 'DimensionName' => [ - 'description' => 'The dimension of the aggregated data being queried.', - 'type' => 'string', - 'example' => 'ALL', - 'title' => '', - ], - 'DimensionValue' => [ - 'description' => 'The value of the aggregated dimension being queried.', - 'type' => 'string', - 'example' => 'ALL', - 'title' => '', - ], - 'AggMethod' => [ - 'description' => 'The aggregation method used.', - 'type' => 'string', - 'example' => 'sum', - 'title' => '', - ], - 'Value' => [ - 'description' => 'The aggregated value.', - 'type' => 'any', - 'example' => '12345', - 'title' => '', - ], + 'FieldName' => ['description' => 'The value of the aggregated metric being queried.', 'type' => 'string', 'example' => 'Traffic', 'title' => ''], + 'DimensionName' => ['description' => 'The dimension of the aggregated data being queried.', 'type' => 'string', 'example' => 'ALL', 'title' => ''], + 'DimensionValue' => ['description' => 'The value of the aggregated dimension being queried.', 'type' => 'string', 'example' => 'ALL', 'title' => ''], + 'AggMethod' => ['description' => 'The aggregation method used.', 'type' => 'string', 'example' => 'sum', 'title' => ''], + 'Value' => ['description' => 'The aggregated value.', 'type' => 'any', 'example' => '12345', 'title' => ''], ], 'description' => '', 'title' => '', @@ -34262,42 +18817,15 @@ 'title' => '', 'example' => '', ], - 'RequestId' => [ - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', - 'title' => '', - ], - 'StartTime' => [ - 'description' => 'The start time for fetching the data.'."\n" - ."\n" - .'The date format follows ISO8601 notation and uses UTC+0, formatted as yyyy-MM-ddTHH:mm:ssZ.', - 'type' => 'string', - 'example' => '2023-04-08T16:00:00Z', - 'title' => '', - ], - 'EndTime' => [ - 'description' => 'The end time for fetching the data.'."\n" - ."\n" - .'The date format follows ISO8601 notation and uses UTC+0, formatted as yyyy-MM-ddTHH:mm:ssZ.', - 'type' => 'string', - 'example' => '2023-04-09T16:00:00Z', - 'title' => '', - ], - 'Interval' => [ - 'description' => 'The granularity of the data, in seconds.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '300', - 'title' => '', - ], - 'SamplingRate' => [ - 'description' => 'The sampling rate, in %.', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', 'title' => ''], + 'StartTime' => ['description' => 'The start time for fetching the data.'."\n" + ."\n" + .'The date format follows ISO8601 notation and uses UTC+0, formatted as yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2023-04-08T16:00:00Z', 'title' => ''], + 'EndTime' => ['description' => 'The end time for fetching the data.'."\n" + ."\n" + .'The date format follows ISO8601 notation and uses UTC+0, formatted as yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2023-04-09T16:00:00Z', 'title' => ''], + 'Interval' => ['description' => 'The granularity of the data, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '300', 'title' => ''], + 'SamplingRate' => ['description' => 'The sampling rate, in %.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], ], 'description' => '', 'title' => '', @@ -34307,54 +18835,17 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.TimeRange', - 'errorMessage' => 'The specified time range exceeds the limit. Adjust it and try again.', - 'description' => 'The specified time range exceeds the limit. Adjust it and try again.', - ], - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests.Please try again later.', - 'description' => 'Requests are too frequent, please try again later.', - ], - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter verification failed. Check your configurations and try again.', - 'description' => 'Parameter verification failed. Check your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.Function', - 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', - 'description' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', - ], - [ - 'errorCode' => 'InvalidParameter.Field', - 'errorMessage' => 'The specified Field is invalid.', - 'description' => 'The specified Field is invalid. For more information, see OpenAPI Documentation .', - ], - [ - 'errorCode' => 'InvalidParameter.Dimension', - 'errorMessage' => 'The specified Dimension is invalid.', - 'description' => 'The specified Dimension is invalid. For more information, see OpenAPI Documentation .'."\n", - ], - [ - 'errorCode' => 'InvalidTime.Malformed', - 'errorMessage' => 'Specified start time or end time is malformed.', - 'description' => 'The specified time format is incorrect. The time must conform to the yyyy-MM-ddTHH:mm:ssZ format. Please enter it correctly and try again.', - ], - [ - 'errorCode' => 'TooManyDimensions', - 'errorMessage' => 'Too many query dimensions specified. Delete some and try again.', - 'description' => 'Too many query dimensions specified. Delete some and try again.', - ], + ['errorCode' => 'InvalidParameter.TimeRange', 'errorMessage' => 'The specified time range exceeds the limit. Adjust it and try again.', 'description' => 'The specified time range exceeds the limit. Adjust it and try again.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter verification failed. Check your configurations and try again.', 'description' => 'Parameter verification failed. Check your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.Function', 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', 'description' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.'], + ['errorCode' => 'InvalidParameter.Field', 'errorMessage' => 'The specified Field is invalid.', 'description' => 'The specified Field is invalid. For more information, see OpenAPI Documentation .'], + ['errorCode' => 'InvalidParameter.Dimension', 'errorMessage' => 'The specified Dimension is invalid.', 'description' => 'The specified Dimension is invalid. For more information, see OpenAPI Documentation .'."\n"], + ['errorCode' => 'InvalidTime.Malformed', 'errorMessage' => 'Specified start time or end time is malformed.', 'description' => 'The specified time format is incorrect. The time must conform to the yyyy-MM-ddTHH:mm:ssZ format. Please enter it correctly and try again.'], + ['errorCode' => 'TooManyDimensions', 'errorMessage' => 'Too many query dimensions specified. Delete some and try again.', 'description' => 'Too many query dimensions specified. Delete some and try again.'], ], ], - '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"}]', 'title' => 'Query Traffic Analysis Time Series Data', 'description' => '- If you do not specify `StartTime` and `EndTime`, the API returns data for the past 24 hours; if you specify `StartTime` and `EndTime`, the API returns data for the specified time period.'."\n" .'- The API returns different time granularities based on the span between `StartTime` and `EndTime`.'."\n" @@ -34367,12 +18858,7 @@ 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '10', - 'countWindow' => 10, - 'regionId' => '*', - 'api' => 'DescribeSiteTimeSeriesData', - ], + ['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'DescribeSiteTimeSeriesData'], ], ], 'ramActions' => [ @@ -34383,26 +18869,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => [ - 'summary' => 'Queries the top-ranking records in a traffic analytics report by website or Alibaba Cloud account.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -34415,94 +18891,55 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239025', - 'abilityTreeNodes' => [ - 'FEATUREdcdnVIK4DM', - 'FEATUREdcdn2Z4HOI', - ], + 'abilityTreeNodes' => ['FEATUREdcdnVIK4DM', 'FEATUREdcdn2Z4HOI'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.'."\n" - ."\n" - .'If you do not specify this parameter, the system returns data by account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1150376036*****'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.'."\n" + ."\n" + .'If you do not specify this parameter, the system returns data by account.', 'type' => 'string', 'required' => false, 'example' => '1150376036*****'."\n", 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n" - ."\n" - .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2023-04-08T16:00:00Z'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The beginning of the time range to query.'."\n" + ."\n" + .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.', 'type' => 'string', 'required' => false, 'example' => '2023-04-08T16:00:00Z'."\n", 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n" - ."\n" - .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n" - ."\n" - .'> The end time must be later than the start time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2023-04-09T16:00:00Z'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The end of the time range to query.'."\n" + ."\n" + .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n" + ."\n" + .'> The end time must be later than the start time.', 'type' => 'string', 'required' => false, 'example' => '2023-04-09T16:00:00Z'."\n", 'title' => ''], ], [ 'name' => 'Interval', 'in' => 'query', - 'schema' => [ - 'description' => 'The time interval between the data entries to return. Unit: seconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '300', - 'title' => '', - ], + 'schema' => ['description' => 'The time interval between the data entries to return. Unit: seconds.', 'type' => 'string', 'required' => false, 'example' => '300', 'title' => ''], ], [ 'name' => 'Fields', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The metrics to query.'."\n", + 'description' => 'The metrics to query.', 'type' => 'array', 'items' => [ - 'description' => 'The metric to query.'."\n", + 'description' => 'The metric to query.', 'type' => 'object', 'properties' => [ - 'FieldName' => [ - 'description' => 'The metric name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Traffic', - 'title' => '', - ], + 'FieldName' => ['description' => 'The metric name.', 'type' => 'string', 'required' => false, 'example' => 'Traffic', 'title' => ''], 'Dimension' => [ - 'description' => 'The dimensions at which you want to query data.'."\n", + 'description' => 'The dimensions at which you want to query data.', 'type' => 'array', - 'items' => [ - 'description' => 'The dimension at which you want to query data.'."\n" - ."\n" - .'> For more information, see the corresponding log fields.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ALL', - 'title' => '', - ], + 'items' => ['description' => 'The dimension at which you want to query data.'."\n" + ."\n" + .'> For more information, see the corresponding log fields.', 'type' => 'string', 'required' => false, 'example' => 'ALL', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', @@ -34521,24 +18958,12 @@ 'name' => 'Limit', 'in' => 'query', 'schema' => [ - 'description' => 'The number of top-ranking data entries to query.'."\n", + 'description' => 'The number of top-ranking data entries to query.', + 'enumValueTitles' => [5 => '5', 10 => '10', 150 => '150'], 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 5 => '5', - 10 => '10', - 150 => '150', - ], 'default' => '300', - 'enum' => [ - '5', - '10', - '15', - '100', - '150', - '999', - '300', - ], + 'enum' => ['5', '10', '15', '100', '150', '999', '300'], + 'required' => false, 'example' => '5', 'title' => '', ], @@ -34550,43 +18975,23 @@ 'type' => 'object', 'properties' => [ 'Data' => [ - 'description' => 'The returned data.'."\n", + 'description' => 'The returned data.', 'type' => 'array', 'items' => [ - 'description' => 'The returned data.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'FieldName' => [ - 'description' => 'The metric name.'."\n", - 'type' => 'string', - 'example' => 'Traffic', - 'title' => '', - ], - 'DimensionName' => [ - 'description' => 'The dimension at which data was queried.'."\n", - 'type' => 'string', - 'example' => 'ALL', - 'title' => '', - ], + 'FieldName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'Traffic', 'title' => ''], + 'DimensionName' => ['description' => 'The dimension at which data was queried.', 'type' => 'string', 'example' => 'ALL', 'title' => ''], 'DetailData' => [ - 'description' => 'The returned data.'."\n", + 'description' => 'The returned data.', 'type' => 'array', 'items' => [ - 'description' => 'The returned data.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'DimensionValue' => [ - 'description' => 'The dimension value.'."\n", - 'type' => 'string', - 'example' => 'ALL', - 'title' => '', - ], - 'Value' => [ - 'description' => 'The queried numeric value.'."\n", - 'type' => 'any', - 'example' => '123', - 'title' => '', - ], + 'DimensionValue' => ['description' => 'The dimension value.', 'type' => 'string', 'example' => 'ALL', 'title' => ''], + 'Value' => ['description' => 'The queried numeric value.', 'type' => 'any', 'example' => '123', 'title' => ''], ], 'title' => '', 'example' => '', @@ -34601,35 +19006,14 @@ 'title' => '', 'example' => '', ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '35C66C7B-671H-4297-9187-2C447724****', - 'title' => '', - ], - 'StartTime' => [ - 'description' => 'The beginning of the time range during which data was queried.'."\n" - ."\n" - .'The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-04-08T16:00:00Z', - 'title' => '', - ], - 'EndTime' => [ - 'description' => 'The end of the time range during which data was queried.'."\n" - ."\n" - .'The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-04-09T16:00:00Z', - 'title' => '', - ], - 'SamplingRate' => [ - 'description' => 'The sampling rate.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '35C66C7B-671H-4297-9187-2C447724****', 'title' => ''], + 'StartTime' => ['description' => 'The beginning of the time range during which data was queried.'."\n" + ."\n" + .'The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2023-04-08T16:00:00Z', 'title' => ''], + 'EndTime' => ['description' => 'The end of the time range during which data was queried.'."\n" + ."\n" + .'The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2023-04-09T16:00:00Z', 'title' => ''], + 'SamplingRate' => ['description' => 'The sampling rate.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], ], 'description' => '', 'title' => '', @@ -34639,67 +19023,26 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.TimeRange', - 'errorMessage' => 'The specified time range exceeds the limit. Adjust it and try again.', - 'description' => 'The specified time range exceeds the limit. Adjust it and try again.', - ], - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests.Please try again later.', - 'description' => 'Requests are too frequent, please try again later.', - ], - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter verification failed. Check your configurations and try again.', - 'description' => 'Parameter verification failed. Check your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.Function', - 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', - 'description' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', - ], - [ - 'errorCode' => 'InvalidParameter.Field', - 'errorMessage' => 'The specified Field is invalid.', - 'description' => 'The specified Field is invalid. For more information, see OpenAPI Documentation .', - ], - [ - 'errorCode' => 'InvalidParameter.Dimension', - 'errorMessage' => 'The specified Dimension is invalid.', - 'description' => 'The specified Dimension is invalid. For more information, see OpenAPI Documentation .'."\n", - ], - [ - 'errorCode' => 'InvalidTime.Malformed', - 'errorMessage' => 'Specified start time or end time is malformed.', - 'description' => 'The specified time format is incorrect. The time must conform to the yyyy-MM-ddTHH:mm:ssZ format. Please enter it correctly and try again.', - ], - [ - 'errorCode' => 'TooManyDimensions', - 'errorMessage' => 'Too many query dimensions specified. Delete some and try again.', - 'description' => 'Too many query dimensions specified. Delete some and try again.', - ], + ['errorCode' => 'InvalidParameter.TimeRange', 'errorMessage' => 'The specified time range exceeds the limit. Adjust it and try again.', 'description' => 'The specified time range exceeds the limit. Adjust it and try again.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter verification failed. Check your configurations and try again.', 'description' => 'Parameter verification failed. Check your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.Function', 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', 'description' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.'], + ['errorCode' => 'InvalidParameter.Field', 'errorMessage' => 'The specified Field is invalid.', 'description' => 'The specified Field is invalid. For more information, see OpenAPI Documentation .'], + ['errorCode' => 'InvalidParameter.Dimension', 'errorMessage' => 'The specified Dimension is invalid.', 'description' => 'The specified Dimension is invalid. For more information, see OpenAPI Documentation .'."\n"], + ['errorCode' => 'InvalidTime.Malformed', 'errorMessage' => 'Specified start time or end time is malformed.', 'description' => 'The specified time format is incorrect. The time must conform to the yyyy-MM-ddTHH:mm:ssZ format. Please enter it correctly and try again.'], + ['errorCode' => 'TooManyDimensions', 'errorMessage' => 'Too many query dimensions specified. Delete some and try again.', 'description' => 'Too many query dimensions specified. Delete some and try again.'], ], ], - '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"}]', 'title' => 'DescribeSiteTopData', - 'description' => '- 如果您不指定 StartTime 和 EndTime，该接口返回过去 24 小时的数据；指定 StartTime 和 EndTime，该接口返回指定时间段的数据。'."\n" + 'summary' => 'Queries the top-ranking records in a traffic analytics report by website or Alibaba Cloud account.', + 'description' => '- If you do not specify StartTime and EndTime, data from the last 24 hours is returned. If you specify StartTime and EndTime, data for the specified time range is returned.'."\n" ."\n" - .'- 由于查询时间段的访问次数较多，数据分析可能经过采样。', + .'- Due to a large number of visits during the queried time range, the data analytics results may be sampled.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '10', - 'countWindow' => 10, - 'regionId' => '*', - 'api' => 'DescribeSiteTopData', - ], + ['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'DescribeSiteTopData'], ], ], 'ramActions' => [ @@ -34710,28 +19053,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => 'Queries the page monitoring data.', - 'description' => '', - 'path' => '/', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DescribeSiteWafTimeSeriesData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -34743,470 +19074,573 @@ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '255157', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '255155', + 'abilityTreeNodes' => ['FEATUREdcdnVIK4DM', 'FEATUREdcdn2Z4HOI'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '54362329990032', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.'."\n" + ."\n" + .'If this parameter is left empty, user-level data is queried.', 'type' => 'string', 'required' => false, 'example' => '11089268296****', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n" - ."\n" - .'The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2023-04-08T16:00:00Z', - 'title' => '', - ], + 'schema' => ['description' => 'The beginning of the time range to query.'."\n" + ."\n" + .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.', 'type' => 'string', 'required' => false, 'example' => '2023-04-08T16:00:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n" - ."\n" - .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2023-04-19T15:59:59Z', - 'title' => '', - ], + 'schema' => ['description' => 'The end of the time range to query.'."\n" + ."\n" + .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.'."\n" + ."\n" + .'> The end time must be later than the start time.', 'type' => 'string', 'required' => false, 'example' => '2023-04-09T16:00:00Z', 'title' => ''], ], [ - 'name' => 'Url', + 'name' => 'Interval', 'in' => 'query', - 'schema' => [ - 'description' => 'The URL of the web page to monitor.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'example.com/test', - 'title' => '', - ], + 'schema' => ['description' => 'The time granularity of the queried data. Unit: seconds.'."\n" + ."\n" + .'Based on the maximum time span of a single query, this parameter supports the values 60 (1 minute), 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). For more information, see the **supported time granularity** section above.', 'type' => 'string', 'required' => false, 'example' => '300', 'title' => ''], ], [ - 'name' => 'ClientPlatform', + 'name' => 'Fields', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The platform of the device. If the parameter is left empty, all devices are queried.'."\n" - ."\n" - .'* PC'."\n" - .'* Mobile'."\n", - 'type' => 'string', - 'required' => false, - 'enum' => [ - 'PC', - 'Mobile', + 'description' => 'The query metrics.', + 'type' => 'array', + 'items' => [ + 'description' => 'The query metrics.', + 'type' => 'object', + 'properties' => [ + 'FieldName' => ['description' => 'The metric name.'."\n" + ."\n" + .'>For more information about the available dimensions, see [Data analytics field description](~~2878520~~).', 'type' => 'string', 'required' => false, 'example' => 'Traffic', 'title' => ''], + 'Dimension' => [ + 'description' => 'The query dimension.', + 'type' => 'array', + 'items' => ['description' => 'The query dimension.'."\n" + ."\n" + .'>For more information about the available dimensions, see [Data analytics field description](~~2878520~~).', 'type' => 'string', 'required' => false, 'example' => 'ALL', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'example' => 'PC', - 'title' => '', - ], - ], - [ - 'name' => 'Metric', - 'in' => 'query', - 'schema' => [ - 'description' => 'The metric data that is detected.'."\n" - ."\n" - .'* TTFB: Measures the time between when a resource initiates a request and when the first byte of the response starts to arrive.'."\n" - .'* FCP: Measures the time between when the page is loaded and when any part of the page\'s content is rendered on the screen.'."\n" - .'* LCP: Reports the rendering time of the largest image or text block visible in the viewport.'."\n" - .'* CLS: A metric that measures the maximum layout mutation score for every unexpected layout change that occurs throughout the life of the page.'."\n" - .'* INP: Measures the responsiveness of the page, or how long it takes for the page to respond to user input in a visible way.'."\n" - .'* FID: Measures the time between when the user first interacts with the page and when the browser is actually able to start processing the event handler in response to that interaction.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TTFB', + 'required' => true, 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'UrlDetailData' => [ - 'description' => 'The objects that are returned.'."\n", + 'Data' => [ + 'description' => 'The returned data.', 'type' => 'array', 'items' => [ + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'Url' => [ - 'description' => 'The URL of the web page to monitor.'."\n", - 'type' => 'string', - 'example' => 'example.com/test', - 'title' => '', - ], - 'ClientPlatform' => [ - 'description' => 'The platform of the device.'."\n", - 'type' => 'string', - 'example' => 'PC', - 'title' => '', - ], - 'Country' => [ - 'description' => 'The country or region to which the IP address belongs.'."\n", - 'type' => 'string', - 'example' => 'CN', - 'title' => '', - ], - 'TTFB' => [ - 'description' => 'This metric measures the time between when a resource initiates a request and when the first byte of the response starts to arrive. Unit: ms.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '123', - 'title' => '', - ], - 'FCP' => [ - 'description' => 'Measures the time between when the page is loaded and when any part of the page\'s content is rendered on the screen. Unit: ms.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '123', - 'title' => '', - ], - 'LCP' => [ - 'description' => 'Reports the rendering time of the largest image or text block visible in the viewport. Unit: ms.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '123', - 'title' => '', - ], - 'CLS' => [ - 'description' => 'Measures the maximum layout mutation score for every unexpected layout change that occurs throughout the life of the page.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - 'title' => '', - ], - 'FID' => [ - 'description' => 'Measures the time between when the user first interacts with the page and when the browser is actually able to start processing an event handler in response to that interaction. Unit: ms.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '123', - 'title' => '', - ], - 'INP' => [ - 'description' => 'Measures the responsiveness of the page, or how long it takes for the page to respond to user input visibly. Unit: ms.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '123', + 'FieldName' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'Traffic', 'title' => ''], + 'DimensionName' => ['description' => 'The query dimension.', 'type' => 'string', 'example' => 'ALL', 'title' => ''], + 'DimensionValue' => ['description' => 'The dimension value.', 'type' => 'string', 'example' => 'ALL', 'title' => ''], + 'DetailData' => [ + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => ['description' => 'The start time of the time slice.', 'type' => 'string', 'example' => '2023-04-08T16:00:00Z', 'title' => ''], + 'Value' => ['description' => 'The value.', 'type' => 'any', 'example' => '123', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], 'title' => '', + 'example' => '', ], ], - 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - 'title' => '', - ], - 'StartTime' => [ - 'description' => 'The create time. The time is in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", - 'type' => 'string', - 'example' => '2022-11-06T16:00:00Z', - 'title' => '', - ], - 'EndTime' => [ - 'description' => 'The end of the time range during which data was queried.'."\n" - ."\n" - .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The time must be in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-04-19T15:59:59Z', + 'SummarizedData' => [ + 'description' => 'The summarized data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The summarized data.', + 'type' => 'object', + 'properties' => [ + 'FieldName' => ['description' => 'The summarized metric name.', 'type' => 'string', 'example' => 'Traffic', 'title' => ''], + 'DimensionName' => ['description' => 'The summarized dimension name.', 'type' => 'string', 'example' => 'ALL', 'title' => ''], + 'DimensionValue' => ['description' => 'The summarized dimension value.', 'type' => 'string', 'example' => 'ALL', 'title' => ''], + 'AggMethod' => ['description' => 'The aggregation method.', 'type' => 'string', 'example' => 'sum', 'title' => ''], + 'Value' => ['description' => 'The aggregated value.', 'type' => 'any', 'example' => '123456', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '93652946-2687-5428-8254-533B1E6A***', 'title' => ''], + 'StartTime' => ['description' => 'The beginning of the time range to query.'."\n" + ."\n" + .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.', 'type' => 'string', 'example' => '2023-04-08T16:00:00Z', 'title' => ''], + 'EndTime' => ['description' => 'The end of the time range for the returned data.'."\n" + ."\n" + .'The time is in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC+0.', 'type' => 'string', 'example' => '2023-04-09T16:00:00Z', 'title' => ''], + 'Interval' => ['description' => 'The data granularity. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '300', 'title' => ''], + 'SamplingRate' => ['description' => 'The sampling rate. Unit: %.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], ], + 'description' => '', + 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.TimeRange', - 'errorMessage' => 'The specified time range exceeds the limit. Adjust it and try again.', - 'description' => 'The specified time range exceeds the limit. Adjust it and try again.', - ], - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests.Please try again later.', - 'description' => 'Requests are too frequent, please try again later.', - ], - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter verification failed. Check your configurations and try again.', - 'description' => 'Parameter verification failed. Check your configurations and try again.', - ], - [ - 'errorCode' => 'InvalidTime.Malformed', - 'errorMessage' => 'Specified start time or end time is malformed.', - 'description' => 'The specified time format is incorrect. The time must conform to the yyyy-MM-ddTHH:mm:ssZ format. Please enter it correctly and try again.', - ], + ['errorCode' => 'InvalidParameter.TimeRange', 'errorMessage' => 'The specified time range exceeds the limit. Adjust it and try again.', 'description' => 'The specified time range exceeds the limit. Adjust it and try again.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter verification failed. Check your configurations and try again.', 'description' => 'Parameter verification failed. Check your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.Function', 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', 'description' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.'], + ['errorCode' => 'InvalidParameter.Field', 'errorMessage' => 'The specified Field is invalid.', 'description' => 'The specified Field is invalid. For more information, see OpenAPI Documentation .'], + ['errorCode' => 'InvalidParameter.Dimension', 'errorMessage' => 'The specified Dimension is invalid.', 'description' => 'The specified Dimension is invalid. For more information, see OpenAPI Documentation .'."\n"], + ['errorCode' => 'InvalidTime.Malformed', 'errorMessage' => 'Specified start time or end time is malformed.', 'description' => 'The specified time format is incorrect. The time must conform to the yyyy-MM-ddTHH:mm:ssZ format. Please enter it correctly and try again.'], + ['errorCode' => 'TooManyDimensions', 'errorMessage' => 'Too many query dimensions specified. Delete some and try again.', 'description' => 'Too many query dimensions specified. Delete some and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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"}]', - 'title' => 'DescribeUrlObservationData', + 'title' => 'Query site WAF analysis time series data', + 'summary' => 'Retrieves time series data for WAF event analysis of a website.', + 'description' => '- If you do not specify StartTime and EndTime, this operation returns data from the past 24 hours. If you specify StartTime and EndTime, this operation returns data for the specified time range.'."\n" + .'- The time granularity of the returned data varies based on the time span between StartTime and EndTime.'."\n" + .' * Less than or equal to 3 hours: returns data at a 1-minute granularity.'."\n" + .' * Greater than 3 hours and less than or equal to 12 hours: returns data at a 5-minute granularity.'."\n" + .' * Greater than 12 hours and less than or equal to 1 day: returns data at a 15-minute granularity.'."\n" + .' * Greater than 1 day and less than or equal to 10 days: returns data at an hourly granularity.'."\n" + .' * Greater than 10 days and less than or equal to 31 days: returns data at a daily granularity.'."\n" + .'- Because the number of access requests during the query period may be large, the data analytics results may undergo sampling.', '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}', - ], - ], - ], - ], + 'flowControlList' => [], ], + 'ramActions' => [], + '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\\": \\"123456\\"\\n }\\n ],\\n \\"RequestId\\": \\"93652946-2687-5428-8254-533B1E6A***\\",\\n \\"StartTime\\": \\"2023-04-08T16:00:00Z\\",\\n \\"EndTime\\": \\"2023-04-09T16:00:00Z\\",\\n \\"Interval\\": 300,\\n \\"SamplingRate\\": 100\\n}","type":"json"}]', ], - 'DisableCustomScenePolicy' => [ - 'summary' => 'Disables a scenario-specific policy.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeSiteWafTopData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '239134', - 'abilityTreeNodes' => [ - 'FEATUREdcdnL8HX1L', - ], + 'abilityTreeCode' => '254966', + 'abilityTreeNodes' => ['FEATUREdcdnVIK4DM', 'FEATUREdcdn2Z4HOI'], ], 'parameters' => [ [ - 'name' => 'PolicyId', + 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The policy ID, which can be obtained by calling the [DescribeCustomScenePolicies](~~2850508~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '1', - 'example' => '100001', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.'."\n" + ."\n\n" + .'If this parameter is left empty, user-level data is queried.', 'type' => 'string', 'required' => false, 'example' => '1150376036*****', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9732E117-8A37-49FD-A36F-ABBB87556CA7', - ], - 'PolicyId' => [ - 'description' => 'The ID of the disabled policy.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100001', - 'title' => '', + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query.'."\n" + ."\n" + .'Specify the time in ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.', 'type' => 'string', 'required' => false, 'example' => '2023-04-08T16:00:00Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query.'."\n" + ."\n" + .'Specify the time in ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.'."\n" + ."\n" + .'> The end time must be later than the start time.', 'type' => 'string', 'required' => false, 'example' => '2023-04-09T16:00:00Z', 'title' => ''], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => ['description' => 'The time granularity for querying data. Unit: seconds.', 'type' => 'string', 'required' => false, 'example' => '300', 'title' => ''], + ], + [ + 'name' => 'Fields', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The query metrics.', + 'type' => 'array', + 'items' => [ + 'description' => 'The query metrics.', + 'type' => 'object', + 'properties' => [ + 'FieldName' => ['description' => 'The query metric value.'."\n" + ."\n" + .'> For specific dimensions, see [Data analytics field description](~~2878520~~).', 'type' => 'string', 'required' => false, 'example' => 'Requests', 'title' => ''], + 'Dimension' => [ + 'description' => 'The query dimension.', + 'type' => 'array', + 'items' => ['description' => 'The query dimension.'."\n" + ."\n" + .'> For specific dimensions, see [Data analytics field description](~~2878520~~).', 'type' => 'string', 'required' => false, 'example' => 'ALL', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => true, + 'title' => '', 'example' => '', ], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'PolicyNotExist', - 'errorMessage' => 'The policy does not exist.', - 'description' => 'The policy does not exist. ', + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of top data entries to query.', + 'enumValueTitles' => [5 => '5', 10 => '10', 150 => '150'], + 'type' => 'string', + 'default' => '300', + 'enum' => ['5', '10', '15', '100', '150', '999', '300'], + 'required' => false, + 'example' => '5', + 'title' => '', ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'FieldName' => ['description' => 'The query metric value.', 'type' => 'string', 'example' => 'Requests', 'title' => ''], + 'DimensionName' => ['description' => 'The query dimension.', 'type' => 'string', 'example' => 'ALL', 'title' => ''], + 'DetailData' => [ + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'DimensionValue' => ['description' => 'The query dimension value.', 'type' => 'string', 'example' => 'ALL', 'title' => ''], + 'Value' => ['description' => 'The value.', 'type' => 'any', 'example' => '123', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '64041D4F-B615-5DEB-AC94-F01EE433****', 'title' => ''], + 'StartTime' => ['description' => 'The beginning of the time range to query.'."\n" + ."\n" + .'Specify the time in ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.', 'type' => 'string', 'example' => '2023-04-08T16:00:00Z', 'title' => ''], + 'EndTime' => ['description' => 'The end of the time range for the returned data.'."\n" + ."\n" + .'The time is in ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC+0.', 'type' => 'string', 'example' => '2023-04-09T16:00:00Z', 'title' => ''], + 'SamplingRate' => ['description' => 'The sampling rate. Unit: %.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter.TimeRange', 'errorMessage' => 'The specified time range exceeds the limit. Adjust it and try again.', 'description' => 'The specified time range exceeds the limit. Adjust it and try again.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter verification failed. Check your configurations and try again.', 'description' => 'Parameter verification failed. Check your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.Function', 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', 'description' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.'], + ['errorCode' => 'InvalidParameter.Field', 'errorMessage' => 'The specified Field is invalid.', 'description' => 'The specified Field is invalid. For more information, see OpenAPI Documentation .'], + ['errorCode' => 'InvalidParameter.Dimension', 'errorMessage' => 'The specified Dimension is invalid.', 'description' => 'The specified Dimension is invalid. For more information, see OpenAPI Documentation .'."\n"], + ['errorCode' => 'InvalidTime.Malformed', 'errorMessage' => 'Specified start time or end time is malformed.', 'description' => 'The specified time format is incorrect. The time must conform to the yyyy-MM-ddTHH:mm:ssZ format. Please enter it correctly and try again.'], + ['errorCode' => 'TooManyDimensions', 'errorMessage' => 'Too many query dimensions specified. Delete some and try again.', 'description' => 'Too many query dimensions specified. Delete some and try again.'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9732E117-8A37-49FD-A36F-ABBB87556CA7\\",\\n \\"PolicyId\\": 100001\\n}","type":"json"}]', - 'title' => 'DisableCustomScenePolicy', + 'title' => 'Query site WAF event analysis top data', + 'summary' => 'Retrieves the top data from WAF event analysis for a website.', + 'description' => '- If you do not specify StartTime or EndTime, this operation returns data from the past 24 hours. If you specify StartTime and EndTime, this operation returns data for the specified time range.'."\n" + ."\n" + .'- Because of the high volume of access requests during the query period, data analytics may involve sampling.', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'DisableCustomScenePolicy', + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"FieldName\\": \\"Requests\\",\\n \\"DimensionName\\": \\"ALL\\",\\n \\"DetailData\\": [\\n {\\n \\"DimensionValue\\": \\"ALL\\",\\n \\"Value\\": \\"123\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"64041D4F-B615-5DEB-AC94-F01EE433****\\",\\n \\"StartTime\\": \\"2023-04-08T16:00:00Z\\",\\n \\"EndTime\\": \\"2023-04-09T16:00:00Z\\",\\n \\"SamplingRate\\": 100\\n}","type":"json"}]', + ], + 'DescribeTraceDiagnoseReport' => [ + 'summary' => 'Retrieves the details of a diagnostic report. 1. Call GenerateTraceDiagnose to obtain a diagnostic link. 2. Open the link in a browser to complete client-side diagnostics. 3. Call ListTraceTasks to obtain the TaskId or TraceId. 4. Call this operation to retrieve the report.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '241915', + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The diagnostic task ID. You must specify at least one of TraceId and TaskId. If neither is specified, the API returns an error.', 'type' => 'string', 'example' => 'xxxxxxxxx-x-x-xxxxxxxxxxxxxxx', 'required' => false], + ], + [ + 'name' => 'TraceId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The diagnostic trace ID. You must specify at least one of TraceId and TaskId. If neither is specified, the API returns an error.', 'type' => 'string', 'example' => '0000xxxxxxxxxxxxxxxxxxxxxx75e', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74'], + 'ClientAddr' => ['description' => 'The IP address of the local DNS server.', 'type' => 'string', 'example' => '47.xx.112.120', 'title' => ''], + 'ClientInfo' => [ + 'description' => 'The client information.', + 'type' => 'object', + 'properties' => [ + 'BrowserInfo' => ['description' => 'The browser.', 'type' => 'string', 'example' => 'Chrome', 'title' => ''], + 'Os' => ['description' => 'The operating system name.', 'type' => 'string', 'example' => 'Macintosh', 'title' => ''], + 'UaString' => ['description' => 'The version.', 'type' => 'string', 'example' => 'Mozilla/5.0 (Macintosh Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/97.0.4692.71 Safari/537.36', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'ClientIp' => ['description' => 'The client IP address.', 'type' => 'string', 'example' => '33.7.98.136', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time. Format: yyyy-MM-dd HH:mm:ss. Time zone: UTC+8.', 'type' => 'string', 'example' => '2024-03-11T01:23:21Z'."\n", 'title' => ''], + 'DiagnoseId' => ['description' => 'The diagnostic ID.', 'type' => 'string', 'example' => 'vpndgn-hn316ixao7ut50ybl5qui', 'title' => ''], + 'DiagnoseReportLink' => ['description' => 'The diagnostic report link.', 'type' => 'string', 'example' => 'https://cdnskyeye.alibaba-inc.com/#/databrain/detectionPlatformAction?module=trace&id=xxx&instance_id=xxxx&type=copy&edition_id=xxxxx', 'title' => ''], + 'DiagnoseUrl' => ['description' => 'The diagnostic link.', 'type' => 'string', 'example' => 'http://cdn.dns-detect.alicdn.com/diagnose/xxxxxx', 'title' => ''], + 'Domain' => ['description' => 'The diagnosed domain name.', 'type' => 'string', 'example' => 'www.pecmnr.cn', 'title' => ''], + 'ExpireTime' => ['description' => 'The expiration time. Unit: seconds. The value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1678701915', 'title' => ''], + 'RemainDiagnoseTimes' => ['description' => 'The remaining number of available diagnostic attempts.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'Report' => [ + 'description' => 'The diagnostic report details.', + 'type' => 'object', + 'properties' => [ + 'ClientInfo' => ['description' => 'The client information.', 'type' => 'string', 'example' => 'Client IP : xxx.xxx.xxx.xxx DNS_IP : xxx.xxx.xxx.xxx ', 'title' => ''], + 'DiagnoseResult' => ['description' => 'The diagnostic result.', 'type' => 'string', 'example' => 'Diagnosis Result: Normal Scheduling Result: Normal Check Item Details: Exception Item: [Request Normal]', 'title' => ''], + 'ResponseHeader' => ['description' => 'The response header of the client request.', 'type' => 'string', 'example' => '
connection: keep-alive
content-type: application/json', 'title' => ''], + 'StaticHtml' => ['description' => 'The static snapshot page.', 'type' => 'string', 'example' => 'https://cdn.dns-detect.alicdn.com/diagnose_v2#/snapshot?data=H4sIAAAAAAACA%2B1aeW%2FcxhX%2FKgSLFkm7pGbI4bWGUSiSEqmxZMG7Tow4hjAkh1pGFLkmuVorgYE4QeI0cc7eB3IgLpIWTdO4ORzXQb6MV5b%2F6lfomyG5u1xpbUW2mwSNpAWWM2%2FmHfPm935DzTNyHm6yLKebXbkpa0gzFWQo2Gkjp4nNpm6qBJtPyA052WLpVsj6cvMZ2Y%2BzeZYzLw%2BTmD%2Fn7FwOo%2BdXWjsfvT%2B4ehXEvSRKUmj7kaF5BFP5fEOOEo9GJ9OoDerGRt18%2BfOdZy%2FcfPcCQWRw%2FbmJ4UFAfBLw4Vm42YtoziaG73z43s4r7%2Bx89srux7%2B59fyHg5devN0kfrJJw3iFbjJoH3xxZXD54s57L8lVxxxL8zAIPVDDp66cSVmWRFtsrsO8jTHVS6tb5u4H7%2B%2B8%2FcbtVAq355I45vHaCvPtceNfemPw8js3X7t44%2Bo1jNCP%2F3P90u7Xb9969o87z34wPZTcD5bTMMr4VGF3KQ4S%2Fk1oWuLriJGpYqzqRMUazBDBgvFWW1MdDZoM1YTWsHu8y1Kai8lv%2Ff7rWxcvDV584eZXb4q%2B1TTZCmNPxOnS725c%2B%2Fvg6nOiYy7pxXkKXsg3rn40%2BNNXPHhxtmeqG9feLHqmTAQ9%2B8wEiZj3wNY87bGJ2MnN08%2FIvTQC8X6%2Fr54NadxnseolmyJGPijQEKpPAU89z2NZoUpu6g15k%2Fkwcr4H1ors1bHWkCkkN11nY60azOSXjzDZac2wVQcVP5qmG1oDBqq6U%2FzYBnKchm7bKi5lMHEQPnO%2BMW4yjcLt3t1bjG17H4uxY9Ytxoah6qU1yCIGMhvYtlRz3ECtoRFDtSq%2FHBtp%2BoTRZ8%2FevcGOsY%2FBGiYTBuuQm2VAHc0gDmlgh6j2WIzBcx0T1axJTRjs0tDv3b3NJrH2i7JorlltErBxLM4NaDHHTeQtBqqtxZnzZxqym4iUTkFzCvld2sLzLqTrcZKF2XKeLvngFnjSah0r90E75OCFLTCaZhkHrCQ%2BwbJelGeFaDeM1%2BcFPhTPi%2B32am2s6cA%2BzjhOENMAAZamSTonQgUY3JBzmq6zvNq3cyvFNDBCfC2R4otP4a%2FYsWneTmmcBSxtFWEFKR7mCjl7Rewq21oszld6m0UDTRld4NMu9uhDLJS59mxjIfbbo7KELcsB7MK2AX9j4VmFyar4FDYvZd2F0tx2ktOo8FfXYYtnSS%2F12FJ3yyz6AX9aUNFYKuAS8Y2rQv7psEvGnuzSoJbwch%2BTiG3oPM8Ekon4DLGsWwZQWLTCYHC8vt4TIWPd2oqVw4XgXCeMaW0VH07STZrnrPR0kVH%2Bja%2FqDFaxBEsmrSS59DBM4j%2BZPhnDWucQYuUY6Ms7TQnxxhbLlbkk2QhZU6Jefy33jmqB5WLNZaPwIqLbJrYZ1glyYKPZpuXqtmH5gYlp4Gg6CVwMAHKkS%2FPO0Zkji3nePR5H20eW6Tlldp0d1aFzUpvnx2sZ8%2B6zxnko2U2pDXtbwo60TLclzmWkgsVoRHpkuc3FYAkhrspsFCV95XgarodxU%2FppYTJPhqa00Jrlj4%2FRdLspzUI6d3NlIQYggXGiI6RNicWZ4lGvw3SsRhpLsGkq2DoNZbeBGvOrZxrTJewG%2F8CiKVizUWN5XNZyarIYNdB4N7FUL7aww7usPYrqvRibU5QQbSRngwLu1CmlFeZMmeP9SksgZVNaXmq1eOdsFCqtfhjkyiNR4tJIaQEsctbYlEYLWc4ixEb909bDqNajGrLAIagpJbAiEmBGF7CVSeTUKUlg07iksLHUztsX6HrEQr8pTU8uLsY%2FsHmAop6g%2FXHImANGVmGGB1WkjrI64E2a9HL2i6yCsM1zWW382NYX%2FKjq5ZBIBUUWGBV4nmlBiVM8x7AU4miB4riupvgAOQwh6um%2BXZqwmrK8BNQK7IeoLOgd0AyolZpmqhrHb2FgobVCuVIIQExXsSVQ7Fw%2BsgxEBGesgHAStnOvuzcOXhWpx4GHx16HuhzM%2BmGaM45J%2B6A%2Fx6j5pB9HCfVbXcYRDBXIthzGxczyhFjRiorGE2UmjNWmKjkeSvztUQUR0R%2B8%2BhoQTLkwlBc3XRS3c93qoFIVIMCOkfJ6sasyAQKwx5s4KwOY9ZIpQQ7L%2BgNbxqUurXxbaZVhRMZYpRrlnKgu9SXXdTyqIIV7L76w%2B9YfBq9f3r34t50r%2Fx5cula6c4J5LNxi%2FrCm5vuVTsRJEKx1m69%2BUX0K6Yp%2FDCM%2F2heFQD8FbDjBzvZg0j1BAU0ZMCRe4aoaBK094CUi67Hp6Lph246t2Zhgwh2O4fRVRjKA8tZL2Qla5W%2BxWnvTohU%2BXTNurGDK5TFhvjjj3LaUQ0Bd1t7ucm2h78mjiCzT3OsUs5WuFjkNTatAATcB9OOkAFBRYwVS8kqbJlG96yT4zktTnDeluU6abLIZwxI4KooJlJsZUXAWkyxv%2BjTrZF7SZSrojMNefwPAeQyveCoXrOLLS4MX%2Fjn4%2BJ3B1eeLAxSnJSLGvqEFPtKJQm3bVQgzdMUB%2Bqn4VIeou55p0IBnbRZNrB7nzYdknwY5NPu0ze8p%2BySGrh%2BCfRIL3z%2F2iUz8HWOf0%2Br0fgSUWo5j4FHFJpquEThpMwsR2zKohjUfiqbNCDVNm3iIBpDPcBQ8NAG9fxoPSEDr9BG4GBC%2BnmMoGAE3xHtJXU3AAF5nTON1GqmJOnXuiDEAi20QHQ6sxh41o17NQA3%2B2V8HRiM5POKOB6RwExT7rkkn%2BWak8wCHgBGZnJooU09YU08Mh6SeyLpX1NOAo5QeoEDxLYKgQECpcOzAVwLPtUzX1d0AW1Opp1GnnoS%2FP4SNTxzVwVO5p%2B4AhhFVQ5ZqobsmnzwSQ%2FK52OuwDk1y9p3mnqZl3nfuORnkO5BP0z4o9xQV6x5yT%2FID9zws97wHPHM%2F%2BvrNuOfgzeuDty7tfPbXm7%2F88tvnnpp2aOr5fX3vSbCDD8E8%2BXug%2B8c8%2BTuJOzPPReYK776Nd551rmVawI%2B82NI157RO9lCgiW6g%2BvtTIBOPyRl1kqVxGmWZhnXa1vcoqHXa2rS3c%2BZQikwQrG%2FAcO74ssxyDEenLhlbT8cghqaxKVx9%2BgCsa4hgz3Cp5wfUdhAUJNMknu8xIBfOoV8W30eNt%2BfqehXFA3PQg747vi3jPTiPns5fD0k1yb1imh6jrufbQDI94ijE1XyFEuIqvh5Yhm76xKZ0GtPkuD5GNOE0BNQGEAkbqkZuxzQdWwU2ajh3zTPJGM18okPj9adCupF8t19yGkj%2FXxDNsRjf6R2nflCaKcpTjWbuXPkXOHfzzxd%2BYJf%2FR%2Bzy%2BruDf3w%2BeP39e0Ytz9Tv%2BRT%2F8YdwPMbSMNgG8Kf8tkzW63aTNF9j4nJMQKOMS4Xra%2BVtn%2BHAoqnIqrmV2eWFpvRAnMTsQQiGBCmapH7WfDKWpPF%2Fy%2FBnYsFZWVeh8GtYm2jQUb0BO059imLE6NkCbfAzVDi0QezVwpWwu0VGNxyGbebQPY9xh891YVv4E41BIO4nsbW8QI3hVTAiIauJSFPD0s%2F49QXpZHtOrk1VH2IDq6mGoL1DqnsYcpyMTDnfkDtQrIeJOfjVq4Nrvx5c%2FvTG1%2B%2FtXPh497UvBq%2F%2FdnD5k91P%2FyIXouO0HbQfd58S16oKQ0xsq5q0mXGdPClLIMQqKRq5GDDMagsC0ogNbVSD8hGHHjWDjUlWXbVKuAfL1AvjPMk6MMRNk35WbCqxWzhUUC6TPB1GEZ0xVCQ9MBxwRFoCvhoB9fCk4y3plITRGjbWrAel2W43Yo8z99EwnzF0S9VN6YFHF9vLxxpSFG4w6RHmbSQPVlsSE1tF%2FFdq0YCmYTlE0GtOqBZi6kZ8qYucEGjSyhN%2Bp2WiK4mPhTEb5sQwHUpIIevijhzEK4w3%2BCsZQNecn9kgKjlAyklx%2FYYvTNacmdl378%2F8nEbhGid4PnN762t8prXQP1oAuWHZWEHw61gYeB0KGMYscC3MgNthD3m6ZzKNIvMnfCE4Cgtw%2BtYifP6%2Fq6Vk7DkpAAA%3D', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'State' => ['description' => 'The report generation status. Valid values:'."\n" + ."\n" + .'0: succeeded.'."\n" + .'1: failed.'."\n" + .'2: timed out.'."\n" + .'3: running.'."\n" + .'4: waiting.', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'Status' => ['description' => 'The status of the diagnostic link. Valid values:'."\n" + ."\n" + .'1: active.'."\n" + .'0: expired.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'xxxxxxx-xxxxx-xxxxx-xxxxxxxxxxx', 'title' => ''], + 'TimeConsuming' => ['description' => 'The time consumed to generate the report. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'TraceDisplayLink' => ['description' => 'The trace display link.', 'type' => 'string', 'example' => 'https://tracing-sk.alibaba-inc.com/trace/xxxxxxxxxxxxxx', 'title' => ''], + 'TraceId' => ['description' => 'The diagnostic trace ID.', 'type' => 'string', 'example' => '0000006xxxxxxxxxxxx533427e', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve diagnostic report details', + 'description' => '>Make sure that you have activated the Layer 4 acceleration service before calling this operation.>1. Call GenerateTraceDiagnose to obtain a diagnostic link. 2. Open the link in a browser to complete client-side diagnostics. 3. Call ListTraceTasks to obtain the TaskId or TraceId. 4. Call this operation to retrieve the report.', + 'extraInfo' => '1. Call GenerateTraceDiagnose to obtain a diagnostic link. 2. Open the link in a browser to complete client-side diagnostics. 3. Call ListTraceTasks to obtain the TaskId or TraceId. 4. Call this operation to retrieve the report.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], 'ramActions' => [ [ - 'operationType' => 'get', + 'operationType' => 'none', 'ramAction' => [ - 'action' => 'esa:DisableCustomScenePolicy', + 'action' => 'esa:DescribeTraceDiagnoseReport', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"ClientAddr\\": \\"47.xx.112.120\\",\\n \\"ClientInfo\\": {\\n \\"BrowserInfo\\": \\"Chrome\\",\\n \\"Os\\": \\"Macintosh\\",\\n \\"UaString\\": \\"Mozilla/5.0 (Macintosh Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/97.0.4692.71 Safari/537.36\\"\\n },\\n \\"ClientIp\\": \\"33.7.98.136\\",\\n \\"CreateTime\\": \\"2024-03-11T01:23:21Z\\\\n\\",\\n \\"DiagnoseId\\": \\"vpndgn-hn316ixao7ut50ybl5qui\\",\\n \\"DiagnoseReportLink\\": \\"https://cdnskyeye.alibaba-inc.com/#/databrain/detectionPlatformAction?module=trace&id=xxx&instance_id=xxxx&type=copy&edition_id=xxxxx\\",\\n \\"DiagnoseUrl\\": \\"http://cdn.dns-detect.alicdn.com/diagnose/xxxxxx\\",\\n \\"Domain\\": \\"www.pecmnr.cn\\",\\n \\"ExpireTime\\": 1678701915,\\n \\"RemainDiagnoseTimes\\": 10,\\n \\"Report\\": {\\n \\"ClientInfo\\": \\"Client IP : xxx.xxx.xxx.xxx DNS_IP : xxx.xxx.xxx.xxx \\",\\n \\"DiagnoseResult\\": \\"Diagnosis Result: Normal Scheduling Result: Normal Check Item Details: Exception Item: [Request Normal]\\",\\n \\"ResponseHeader\\": \\"
connection: keep-alive
content-type: application/json\\",\\n \\"StaticHtml\\": \\"https://cdn.dns-detect.alicdn.com/diagnose_v2#/snapshot?data=H4sIAAAAAAACA%2B1aeW%2FcxhX%2FKgSLFkm7pGbI4bWGUSiSEqmxZMG7Tow4hjAkh1pGFLkmuVorgYE4QeI0cc7eB3IgLpIWTdO4ORzXQb6MV5b%2F6lfomyG5u1xpbUW2mwSNpAWWM2%2FmHfPm935DzTNyHm6yLKebXbkpa0gzFWQo2Gkjp4nNpm6qBJtPyA052WLpVsj6cvMZ2Y%2BzeZYzLw%2BTmD%2Fn7FwOo%2BdXWjsfvT%2B4ehXEvSRKUmj7kaF5BFP5fEOOEo9GJ9OoDerGRt18%2BfOdZy%2FcfPcCQWRw%2FbmJ4UFAfBLw4Vm42YtoziaG73z43s4r7%2Bx89srux7%2B59fyHg5devN0kfrJJw3iFbjJoH3xxZXD54s57L8lVxxxL8zAIPVDDp66cSVmWRFtsrsO8jTHVS6tb5u4H7%2B%2B8%2FcbtVAq355I45vHaCvPtceNfemPw8js3X7t44%2Bo1jNCP%2F3P90u7Xb9969o87z34wPZTcD5bTMMr4VGF3KQ4S%2Fk1oWuLriJGpYqzqRMUazBDBgvFWW1MdDZoM1YTWsHu8y1Kai8lv%2Ff7rWxcvDV584eZXb4q%2B1TTZCmNPxOnS725c%2B%2Fvg6nOiYy7pxXkKXsg3rn40%2BNNXPHhxtmeqG9feLHqmTAQ9%2B8wEiZj3wNY87bGJ2MnN08%2FIvTQC8X6%2Fr54NadxnseolmyJGPijQEKpPAU89z2NZoUpu6g15k%2Fkwcr4H1ors1bHWkCkkN11nY60azOSXjzDZac2wVQcVP5qmG1oDBqq6U%2FzYBnKchm7bKi5lMHEQPnO%2BMW4yjcLt3t1bjG17H4uxY9Ytxoah6qU1yCIGMhvYtlRz3ECtoRFDtSq%2FHBtp%2BoTRZ8%2FevcGOsY%2FBGiYTBuuQm2VAHc0gDmlgh6j2WIzBcx0T1axJTRjs0tDv3b3NJrH2i7JorlltErBxLM4NaDHHTeQtBqqtxZnzZxqym4iUTkFzCvld2sLzLqTrcZKF2XKeLvngFnjSah0r90E75OCFLTCaZhkHrCQ%2BwbJelGeFaDeM1%2BcFPhTPi%2B32am2s6cA%2BzjhOENMAAZamSTonQgUY3JBzmq6zvNq3cyvFNDBCfC2R4otP4a%2FYsWneTmmcBSxtFWEFKR7mCjl7Rewq21oszld6m0UDTRld4NMu9uhDLJS59mxjIfbbo7KELcsB7MK2AX9j4VmFyar4FDYvZd2F0tx2ktOo8FfXYYtnSS%2F12FJ3yyz6AX9aUNFYKuAS8Y2rQv7psEvGnuzSoJbwch%2BTiG3oPM8Ekon4DLGsWwZQWLTCYHC8vt4TIWPd2oqVw4XgXCeMaW0VH07STZrnrPR0kVH%2Bja%2FqDFaxBEsmrSS59DBM4j%2BZPhnDWucQYuUY6Ms7TQnxxhbLlbkk2QhZU6Jefy33jmqB5WLNZaPwIqLbJrYZ1glyYKPZpuXqtmH5gYlp4Gg6CVwMAHKkS%2FPO0Zkji3nePR5H20eW6Tlldp0d1aFzUpvnx2sZ8%2B6zxnko2U2pDXtbwo60TLclzmWkgsVoRHpkuc3FYAkhrspsFCV95XgarodxU%2FppYTJPhqa00Jrlj4%2FRdLspzUI6d3NlIQYggXGiI6RNicWZ4lGvw3SsRhpLsGkq2DoNZbeBGvOrZxrTJewG%2F8CiKVizUWN5XNZyarIYNdB4N7FUL7aww7usPYrqvRibU5QQbSRngwLu1CmlFeZMmeP9SksgZVNaXmq1eOdsFCqtfhjkyiNR4tJIaQEsctbYlEYLWc4ixEb909bDqNajGrLAIagpJbAiEmBGF7CVSeTUKUlg07iksLHUztsX6HrEQr8pTU8uLsY%2FsHmAop6g%2FXHImANGVmGGB1WkjrI64E2a9HL2i6yCsM1zWW382NYX%2FKjq5ZBIBUUWGBV4nmlBiVM8x7AU4miB4riupvgAOQwh6um%2BXZqwmrK8BNQK7IeoLOgd0AyolZpmqhrHb2FgobVCuVIIQExXsSVQ7Fw%2BsgxEBGesgHAStnOvuzcOXhWpx4GHx16HuhzM%2BmGaM45J%2B6A%2Fx6j5pB9HCfVbXcYRDBXIthzGxczyhFjRiorGE2UmjNWmKjkeSvztUQUR0R%2B8%2BhoQTLkwlBc3XRS3c93qoFIVIMCOkfJ6sasyAQKwx5s4KwOY9ZIpQQ7L%2BgNbxqUurXxbaZVhRMZYpRrlnKgu9SXXdTyqIIV7L76w%2B9YfBq9f3r34t50r%2Fx5cula6c4J5LNxi%2FrCm5vuVTsRJEKx1m69%2BUX0K6Yp%2FDCM%2F2heFQD8FbDjBzvZg0j1BAU0ZMCRe4aoaBK094CUi67Hp6Lph246t2Zhgwh2O4fRVRjKA8tZL2Qla5W%2BxWnvTohU%2BXTNurGDK5TFhvjjj3LaUQ0Bd1t7ucm2h78mjiCzT3OsUs5WuFjkNTatAATcB9OOkAFBRYwVS8kqbJlG96yT4zktTnDeluU6abLIZwxI4KooJlJsZUXAWkyxv%2BjTrZF7SZSrojMNefwPAeQyveCoXrOLLS4MX%2Fjn4%2BJ3B1eeLAxSnJSLGvqEFPtKJQm3bVQgzdMUB%2Bqn4VIeou55p0IBnbRZNrB7nzYdknwY5NPu0ze8p%2BySGrh%2BCfRIL3z%2F2iUz8HWOf0%2Br0fgSUWo5j4FHFJpquEThpMwsR2zKohjUfiqbNCDVNm3iIBpDPcBQ8NAG9fxoPSEDr9BG4GBC%2BnmMoGAE3xHtJXU3AAF5nTON1GqmJOnXuiDEAi20QHQ6sxh41o17NQA3%2B2V8HRiM5POKOB6RwExT7rkkn%2BWak8wCHgBGZnJooU09YU08Mh6SeyLpX1NOAo5QeoEDxLYKgQECpcOzAVwLPtUzX1d0AW1Opp1GnnoS%2FP4SNTxzVwVO5p%2B4AhhFVQ5ZqobsmnzwSQ%2FK52OuwDk1y9p3mnqZl3nfuORnkO5BP0z4o9xQV6x5yT%2FID9zws97wHPHM%2F%2BvrNuOfgzeuDty7tfPbXm7%2F88tvnnpp2aOr5fX3vSbCDD8E8%2BXug%2B8c8%2BTuJOzPPReYK776Nd551rmVawI%2B82NI157RO9lCgiW6g%2BvtTIBOPyRl1kqVxGmWZhnXa1vcoqHXa2rS3c%2BZQikwQrG%2FAcO74ssxyDEenLhlbT8cghqaxKVx9%2BgCsa4hgz3Cp5wfUdhAUJNMknu8xIBfOoV8W30eNt%2BfqehXFA3PQg747vi3jPTiPns5fD0k1yb1imh6jrufbQDI94ijE1XyFEuIqvh5Yhm76xKZ0GtPkuD5GNOE0BNQGEAkbqkZuxzQdWwU2ajh3zTPJGM18okPj9adCupF8t19yGkj%2FXxDNsRjf6R2nflCaKcpTjWbuXPkXOHfzzxd%2BYJf%2FR%2Bzy%2BruDf3w%2BeP39e0Ytz9Tv%2BRT%2F8YdwPMbSMNgG8Kf8tkzW63aTNF9j4nJMQKOMS4Xra%2BVtn%2BHAoqnIqrmV2eWFpvRAnMTsQQiGBCmapH7WfDKWpPF%2Fy%2FBnYsFZWVeh8GtYm2jQUb0BO059imLE6NkCbfAzVDi0QezVwpWwu0VGNxyGbebQPY9xh891YVv4E41BIO4nsbW8QI3hVTAiIauJSFPD0s%2F49QXpZHtOrk1VH2IDq6mGoL1DqnsYcpyMTDnfkDtQrIeJOfjVq4Nrvx5c%2FvTG1%2B%2FtXPh497UvBq%2F%2FdnD5k91P%2FyIXouO0HbQfd58S16oKQ0xsq5q0mXGdPClLIMQqKRq5GDDMagsC0ogNbVSD8hGHHjWDjUlWXbVKuAfL1AvjPMk6MMRNk35WbCqxWzhUUC6TPB1GEZ0xVCQ9MBxwRFoCvhoB9fCk4y3plITRGjbWrAel2W43Yo8z99EwnzF0S9VN6YFHF9vLxxpSFG4w6RHmbSQPVlsSE1tF%2FFdq0YCmYTlE0GtOqBZi6kZ8qYucEGjSyhN%2Bp2WiK4mPhTEb5sQwHUpIIevijhzEK4w3%2BCsZQNecn9kgKjlAyklx%2FYYvTNacmdl378%2F8nEbhGid4PnN762t8prXQP1oAuWHZWEHw61gYeB0KGMYscC3MgNthD3m6ZzKNIvMnfCE4Cgtw%2BtYifP6%2Fq6Vk7DkpAAA%3D\\"\\n },\\n \\"State\\": \\"ok\\",\\n \\"Status\\": 1,\\n \\"TaskId\\": \\"xxxxxxx-xxxxx-xxxxx-xxxxxxxxxxx\\",\\n \\"TimeConsuming\\": 10,\\n \\"TraceDisplayLink\\": \\"https://tracing-sk.alibaba-inc.com/trace/xxxxxxxxxxxxxx\\",\\n \\"TraceId\\": \\"0000006xxxxxxxxxxxx533427e\\"\\n}","type":"json"}]', ], - 'EditSiteWafSettings' => [ - 'summary' => 'Edit WAF Configuration for a Site', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DescribeUrlObservationData' => [ + 'summary' => 'Queries the page monitoring data.', + 'description' => '', + 'path' => '/', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '239647', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4VDL9A', - ], + 'abilityTreeCode' => '255157', + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'title' => '站点ID', - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => '54362329990032', 'title' => ''], ], [ - 'name' => 'SiteVersion', + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query.'."\n" + ."\n" + .'The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2023-04-08T16:00:00Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query.'."\n" + ."\n" + .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The time must be in UTC.'."\n", 'type' => 'string', 'required' => false, 'example' => '2023-04-19T15:59:59Z', 'title' => ''], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => ['description' => 'The URL of the web page to monitor.'."\n", 'type' => 'string', 'required' => false, 'example' => 'example.com/test', 'title' => ''], + ], + [ + 'name' => 'ClientPlatform', 'in' => 'query', 'schema' => [ - 'description' => 'Site version.', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The platform of the device. If the parameter is left empty, all devices are queried.'."\n" + ."\n" + .'* PC'."\n" + .'* Mobile'."\n", + 'type' => 'string', 'required' => false, - 'example' => '0', + 'enum' => ['PC', 'Mobile'], + 'example' => 'PC', 'title' => '', ], ], [ - 'name' => 'Settings', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '站点WAF配置', - 'description' => 'WAF configuration information for the site, passed in JSON format.', - 'required' => false, - '$ref' => '#/components/schemas/WafSiteSettings', - 'example' => '', - ], + 'name' => 'Metric', + 'in' => 'query', + 'schema' => ['description' => 'The metric data that is detected.'."\n" + ."\n" + .'* TTFB: Measures the time between when a resource initiates a request and when the first byte of the response starts to arrive.'."\n" + .'* FCP: Measures the time between when the page is loaded and when any part of the page\'s content is rendered on the screen.'."\n" + .'* LCP: Reports the rendering time of the largest image or text block visible in the viewport.'."\n" + .'* CLS: A metric that measures the maximum layout mutation score for every unexpected layout change that occurs throughout the life of the page.'."\n" + .'* INP: Measures the responsiveness of the page, or how long it takes for the page to respond to user input in a visible way.'."\n" + .'* FID: Measures the time between when the user first interacts with the page and when the browser is actually able to start processing the event handler in response to that interaction.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TTFB', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Response Schema', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', + 'UrlDetailData' => [ + 'description' => 'The objects that are returned.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => ['description' => 'The URL of the web page to monitor.'."\n", 'type' => 'string', 'example' => 'example.com/test', 'title' => ''], + 'ClientPlatform' => ['description' => 'The platform of the device.'."\n", 'type' => 'string', 'example' => 'PC', 'title' => ''], + 'Country' => ['description' => 'The country or region to which the IP address belongs.'."\n", 'type' => 'string', 'example' => 'CN', 'title' => ''], + 'TTFB' => ['description' => 'This metric measures the time between when a resource initiates a request and when the first byte of the response starts to arrive. Unit: ms.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '123', 'title' => ''], + 'FCP' => ['description' => 'Measures the time between when the page is loaded and when any part of the page\'s content is rendered on the screen. Unit: ms.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '123', 'title' => ''], + 'LCP' => ['description' => 'Reports the rendering time of the largest image or text block visible in the viewport. Unit: ms.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '123', 'title' => ''], + 'CLS' => ['description' => 'Measures the maximum layout mutation score for every unexpected layout change that occurs throughout the life of the page.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''], + 'FID' => ['description' => 'Measures the time between when the user first interacts with the page and when the browser is actually able to start processing an event handler in response to that interaction. Unit: ms.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '123', 'title' => ''], + 'INP' => ['description' => 'Measures the responsiveness of the page, or how long it takes for the page to respond to user input visibly. Unit: ms.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '123', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', 'title' => ''], + 'StartTime' => ['description' => 'The create time. The time is in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", 'type' => 'string', 'example' => '2022-11-06T16:00:00Z', 'title' => ''], + 'EndTime' => ['description' => 'The end of the time range during which data was queried.'."\n" + ."\n" + .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The time must be in UTC.'."\n", 'type' => 'string', 'example' => '2023-04-19T15:59:59Z', 'title' => ''], ], 'example' => '', ], @@ -35214,275 +19648,205 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - ], - 403 => [ - [ - 'errorCode' => '%s.NotSupport', - 'errorMessage' => 'The specified resource type %s is not supported.', - 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.', - ], - [ - 'errorCode' => '%s.OverQuota', - 'errorMessage' => 'The quantity of %s exceeds the quota.', - 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.', - ], - [ - 'errorCode' => '%s.WrongValueMatched', - 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', - 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.', - ], - [ - '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' => '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.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\"\\n}","type":"json"}]', - 'title' => 'Edit WAF Configuration for a Site', - 'changeSet' => [ - [ - 'createdAt' => '2024-12-19T09:09:37.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-25T07:02:51.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T08:22:13.000Z', - 'description' => 'Error codes changed', + ['errorCode' => 'InvalidParameter.TimeRange', 'errorMessage' => 'The specified time range exceeds the limit. Adjust it and try again.', 'description' => 'The specified time range exceeds the limit. Adjust it and try again.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter verification failed. Check your configurations and try again.', 'description' => 'Parameter verification failed. Check your configurations and try again.'], + ['errorCode' => 'InvalidTime.Malformed', 'errorMessage' => 'Specified start time or end time is malformed.', 'description' => 'The specified time format is incorrect. The time must conform to the yyyy-MM-ddTHH:mm:ssZ format. Please enter it correctly and try again.'], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + '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"}]', + 'title' => 'DescribeUrlObservationData', + 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'EditSiteWafSettings', - ], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUrlObservationData'], ], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ - 'action' => 'esa:EditSiteWafSettings', + 'action' => 'esa:DescribeUrlObservationData', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], ], - 'EnableCustomScenePolicy' => [ - 'summary' => 'Enables a scenario-specific policy.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeWafUsageData' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '238963', - 'abilityTreeNodes' => [ - 'FEATUREdcdnL8HX1L', - ], + 'abilityTreeCode' => '238819', + 'abilityTreeNodes' => ['FEATUREdcdnTC7IYO'], ], 'parameters' => [ [ - 'name' => 'PolicyId', + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.', 'type' => 'string', 'example' => '2022-08-10T00:00:00Z', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.'."\n" + .'>The end time must be later than the start time.', 'type' => 'string', 'example' => '2022-08-10T23:59:59Z', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'SiteId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456****', 'title' => ''], + ], + [ + 'name' => 'SplitBy', 'in' => 'query', 'schema' => [ - 'description' => 'The policy ID, which can be obtained by calling the [DescribeCustomScenePolicies](~~2850508~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '1', - 'example' => '1', + 'description' => 'The grouping key. You can set this parameter to **domain**.'."\n" + ."\n" + .'- **domain**: groups the data by domain name.', + 'type' => 'string', + 'example' => 'domain', + 'enum' => [], + 'required' => false, 'title' => '', ], ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => ['description' => 'The time granularity for the query data, in seconds.'."\n" + ."\n" + .'The valid values vary based on the time range specified by **StartTime** and **EndTime**:'."\n" + ."\n" + .'- Less than 3 days: **300**, **3600**, or **86400**. Default value: **300**.'."\n" + ."\n" + .'- 3 to 31 days (excluding 31 days): **3600** or **86400**. Default value: **3600**.'."\n" + ."\n" + .'- 31 days or more: **86400**. Default value: **86400**.', 'type' => 'string', 'required' => false, 'example' => '300', 'title' => ''], + ], + [ + 'name' => 'RecordName', + 'in' => 'query', + 'schema' => ['description' => 'The domain record name. You can call the [ListSites](~~ListSites~~) operation to obtain the domain record name.', 'type' => 'string', 'required' => false, 'example' => 'test.example.com', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '65C66B7B-671A-8297-9187-2R5477247B76', - ], - 'PolicyId' => [ - 'description' => 'The policy ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'EndTime' => ['description' => 'The end of the time range for the returned data. The time is in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC+0.', 'type' => 'string', 'example' => '2022-08-10T23:59:59Z', 'title' => ''], + 'StartTime' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.', 'type' => 'string', 'example' => '2022-08-10T00:00:00Z', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D2***', 'title' => ''], + 'UsageData' => [ + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'ObserveCount' => ['description' => 'The number of observed requests.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'RecordName' => ['description' => 'The domain record name.', 'type' => 'string', 'example' => 'test.example.com', 'title' => ''], + 'BlockCount' => ['description' => 'The number of blocked requests.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'AccessCount' => ['description' => 'The number of requests with normal access.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'TimeStamp' => ['description' => 'The beginning of the time interval.', 'type' => 'string', 'example' => '2022-08-10T00:00:00Z', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'PolicyNotExist', - 'errorMessage' => 'The policy does not exist.', - 'description' => 'The policy does not exist. ', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65C66B7B-671A-8297-9187-2R5477247B76\\",\\n \\"PolicyId\\": 1\\n}","type":"json"}]', - 'title' => 'EnableCustomScenePolicy', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter verification failed. Check your configurations and try again.', 'description' => 'Parameter verification failed. Check your configurations and try again.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], + ['errorCode' => 'QuotaCheckFailed.Function', 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', 'description' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.'], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'InvalidParameter.TimeRange', 'errorMessage' => 'The specified time range exceeds the limit. Adjust it and try again.', 'description' => 'The specified time range exceeds the limit. Adjust it and try again.'], + ['errorCode' => 'InvalidParameter.Field', 'errorMessage' => 'The specified Field is invalid.', 'description' => 'The specified Field is invalid. For more information, see OpenAPI Documentation .'], + ['errorCode' => 'InvalidTime.Malformed', 'errorMessage' => 'Specified start time or end time is malformed.', 'description' => 'The specified time format is incorrect. The time must conform to the yyyy-MM-ddTHH:mm:ssZ format. Please enter it correctly and try again.'], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - ], - 'ExportRecords' => [ - 'summary' => 'Exports all DNS records of a website domain as a TXT file.', - 'methods' => [ - 'get', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], - 'schemes' => [ - 'https', + 'title' => 'Query WAF usage data', + 'summary' => 'Queries the usage data of WAF by calling DescribeWafUsageData.', + 'description' => '* Maximum storage duration: 93 days.'."\n" + .'* Maximum query time range: 31 days.'."\n" + .'* Default time range: 24 hours.'."\n" + ."\n" + .'All times are expressed in UTC+0.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2022-08-10T23:59:59Z\\",\\n \\"StartTime\\": \\"2022-08-10T00:00:00Z\\",\\n \\"RequestId\\": \\"C370DAF1-C838-4288-A1A0-9A87633D2***\\",\\n \\"UsageData\\": [\\n {\\n \\"ObserveCount\\": 123,\\n \\"RecordName\\": \\"test.example.com\\",\\n \\"BlockCount\\": 123,\\n \\"AccessCount\\": 123,\\n \\"TimeStamp\\": \\"2022-08-10T00:00:00Z\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DisableCustomScenePolicy' => [ + 'summary' => 'Disables a scenario-specific policy.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '239639', - 'abilityTreeNodes' => [ - 'FEATUREdcdnVFT29S', - ], + 'abilityTreeCode' => '239134', + 'abilityTreeNodes' => ['FEATUREdcdnL8HX1L'], ], 'parameters' => [ [ - 'name' => 'SiteId', + 'name' => 'PolicyId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID. You can call the [ListSites](~~2850189~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The policy ID, which can be obtained by calling the [DescribeCustomScenePolicies](~~2850508~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '100001', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C69B5894-D1BA-592C-95D0-DADBE7AEAC63', - ], - 'Content' => [ - 'description' => 'The exported DNS records.'."\n", - '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', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9732E117-8A37-49FD-A36F-ABBB87556CA7'], + 'PolicyId' => ['description' => 'The ID of the disabled policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100001', 'title' => ''], ], 'example' => '', ], @@ -35490,169 +19854,83 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'PolicyNotExist', 'errorMessage' => 'The policy does not exist.', 'description' => 'The policy does not exist. '], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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"}]', - 'title' => 'ExportRecords', - 'changeSet' => [ - [ - 'createdAt' => '2024-09-18T08:22:08.000Z', - 'description' => 'Error codes changed', + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9732E117-8A37-49FD-A36F-ABBB87556CA7\\",\\n \\"PolicyId\\": 100001\\n}","type":"json"}]', + 'title' => 'DisableCustomScenePolicy', + 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ExportRecords', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableCustomScenePolicy'], ], ], 'ramActions' => [ [ - 'operationType' => 'none', + 'operationType' => 'get', 'ramAction' => [ - 'action' => 'esa:ExportRecords', - 'authLevel' => 'resource', + 'action' => 'esa:DisableCustomScenePolicy', + 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'operationType' => 'read', 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], ], - 'GetApiSchemaUsage' => [ - 'summary' => 'Queries the usage of the upload file quota for API security schema verification.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'EditSiteWafSettings' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdcdnOKX321', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '239647', + 'abilityTreeNodes' => ['FEATUREdcdn4VDL9A'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID. You can call the [ListSites](~~2850189~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1159101787****', - 'title' => '', - ], + 'schema' => ['title' => '站点ID', 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) API.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The version of the website.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'Site version.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Settings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['title' => '站点WAF配置', 'description' => 'WAF configuration information for the site, passed in JSON format.', '$ref' => '#/components/schemas/WafSiteSettings', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Response Schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '952ea16b-1f05-4a76-bb32-420282d8****', - ], - 'InstanceId' => [ - 'description' => 'The plan ID.'."\n", - 'type' => 'string', - 'example' => 'esa-site-agknce3n****', - 'title' => '', - ], - 'InstanceUsage' => [ - 'description' => 'The number of files uploaded for schema verification in the plan instance of the website.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'Usages' => [ - 'description' => 'Usage details for websites.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Usage details for a website.'."\n", - 'type' => 'object', - 'properties' => [ - 'Usage' => [ - 'description' => 'The number of files uploaded for the website.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Id' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '40000449', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'test', - 'title' => '', - ], - ], - 'title' => '', - 'example' => '', - ], - 'title' => '', - 'example' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], ], 'example' => '', ], @@ -35660,108 +19938,79 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.ApiShield.Quota', - 'errorMessage' => 'This website does not have the permission to view API security features.', - 'description' => 'This website does not have the permission to view API security features.', - ], - [ - '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' => '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.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ], + 403 => [ + ['errorCode' => '%s.NotSupport', 'errorMessage' => 'The specified resource type %s is not supported.', 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.'], + ['errorCode' => '%s.OverQuota', 'errorMessage' => 'The quantity of %s exceeds the quota.', 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.'], + ['errorCode' => '%s.WrongValueMatched', 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.'], + ['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' => '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.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Edit WAF Configuration for a Site', + 'summary' => 'Edit WAF Configuration for a Site', + 'changeSet' => [ + ['createdAt' => '2024-12-19T09:09:37.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-25T07:02:51.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T08:22:13.000Z', 'description' => 'Error codes changed'], ], - 'title' => 'GetApiSchemaUsage', - 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditSiteWafSettings'], + ], ], 'ramActions' => [ [ - 'operationType' => 'get', + 'operationType' => 'none', 'ramAction' => [ - 'action' => 'esa:GetApiSchemaUsage', + 'action' => 'esa:EditSiteWafSettings', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\"\\n}","type":"json"}]', ], - 'GetCacheReserveSpecification' => [ - 'summary' => 'Queries the available specifications of cache reserve instances.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'EnableCustomScenePolicy' => [ + 'summary' => 'Enables a scenario-specific policy.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '239117', - 'abilityTreeNodes' => [ - 'FEATUREdcdn51XOHW', + 'abilityTreeCode' => '238963', + 'abilityTreeNodes' => ['FEATUREdcdnL8HX1L'], + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => ['description' => 'The policy ID, which can be obtained by calling the [DescribeCustomScenePolicies](~~2850508~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '1', 'title' => ''], ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Details of the request response.', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n", - ], - 'CacheReserveRegion' => [ - 'description' => 'List of cache retention region specifications.', - 'type' => 'array', - 'items' => [ - 'description' => 'Details of the region.', - 'type' => 'string', - 'example' => 'HK', - 'title' => '', - ], - 'title' => '', - 'example' => '', - ], - 'CacheReserveCapacity' => [ - 'description' => 'List of cache retention capacity specifications.', - 'type' => 'array', - 'items' => [ - 'description' => 'Details of the capacity specification. Unit: GB.', - 'type' => 'string', - 'example' => '512000', - 'title' => '', - ], - 'title' => '', - 'example' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '65C66B7B-671A-8297-9187-2R5477247B76'], + 'PolicyId' => ['description' => 'The policy ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'example' => '', ], @@ -35769,48 +20018,31 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'PolicyNotExist', 'errorMessage' => 'The policy does not exist.', 'description' => 'The policy does not exist. '], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\\\n\\",\\n \\"CacheReserveRegion\\": [\\n \\"HK\\"\\n ],\\n \\"CacheReserveCapacity\\": [\\n \\"512000\\"\\n ]\\n}","type":"json"}]', - 'title' => 'GetCacheReserveSpecification', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65C66B7B-671A-8297-9187-2R5477247B76\\",\\n \\"PolicyId\\": 1\\n}","type":"json"}]', + 'title' => 'EnableCustomScenePolicy', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetCacheReserveSpecification', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableCustomScenePolicy'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ - 'action' => 'esa:GetCacheReserveSpecification', + 'action' => 'esa:EnableCustomScenePolicy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -35820,14 +20052,10 @@ 'eventNames' => [], ], ], - 'GetCacheRule' => [ - 'summary' => 'Query a single cache configuration', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ExportRecords' => [ + 'summary' => 'Exports all DNS records of a website domain as a TXT file.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -35836,412 +20064,179 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '257574', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeCode' => '239639', + 'abilityTreeNodes' => ['FEATUREdcdnVFT29S'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', + 'schema' => ['description' => 'The website ID. You can call the [ListSites](~~2850189~~) operation to obtain the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C69B5894-D1BA-592C-95D0-DADBE7AEAC63'], + 'Content' => ['description' => 'The exported DNS records.', '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', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'ExportRecords', + 'changeSet' => [ + ['createdAt' => '2024-09-18T08:22:08.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportRecords'], + ], + ], + 'ramActions' => [], + '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"}]', + ], + 'GenerateTraceDiagnose' => [ + 'summary' => 'Generates a diagnosis link.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ConfigId', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '241915', + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], + ], + 'parameters' => [ + [ + 'name' => 'Url', 'in' => 'query', - 'schema' => [ - 'description' => 'ConfigId of the configuration, which can be obtained by calling the [ListCacheRules](~~2866985~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '352816096987136', - 'title' => '', - ], + 'schema' => ['description' => 'The URL to diagnose.', 'type' => 'string', 'required' => true, 'example' => 'http://www.example.com/xxx.jpg', 'title' => ''], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => ['description' => 'The source of the request.', 'type' => 'string', 'example' => 'ai', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '352816096987136', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'Configuration type, which can be used to query global or rule configurations. Value range:'."\n" - .'- global: Query global configuration;'."\n" - .'- rule: Query rule configuration;', - 'type' => 'string', - 'example' => 'global', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'Version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the effective version of the configuration, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'Rule execution order. The smaller the value, the higher the priority.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Rule switch. This parameter does not need to be set when adding a global configuration. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter does not need to be set when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'example' => '(http.host eq \\"video.example.com\\")'."\n", - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'Rule name. This parameter does not need to be set when adding a global configuration.', - 'type' => 'string', - 'example' => 'rule_example'."\n", - 'title' => '', - ], - 'BypassCache' => [ - 'description' => 'Set bypass cache mode. Value range:'."\n" - ."\n" - .'- cache_all: Cache all requests.'."\n" - .'- bypass_all: Bypass cache for all requests.', - 'type' => 'string', - 'example' => 'cache_all', - 'title' => '', - ], - 'BrowserCacheMode' => [ - 'description' => 'Browser cache mode. Value range:'."\n" - .'- no_cache: Do not cache.'."\n" - .'- follow_origin: Follow origin cache policy.'."\n" - .'- override_origin: Override origin cache policy.', - 'type' => 'string', - 'example' => 'follow_origin', - 'title' => '', - ], - 'BrowserCacheTtl' => [ - 'description' => 'Browser cache expiration time, in seconds.', - 'type' => 'string', - 'example' => '300', - 'title' => '', - ], - 'EdgeCacheMode' => [ - 'description' => 'Edge cache mode. Value range:'."\n" - .'- follow_origin: Follow origin cache policy (if exists), otherwise use the default cache policy.'."\n" - .'- no_cache: Do not cache.'."\n" - .'- override_origin: Override origin cache policy.'."\n" - .'- follow_origin_bypass: Follow origin cache policy (if exists), otherwise do not cache.', - 'type' => 'string', - 'example' => 'follow_origin', - 'title' => '', - ], - 'EdgeCacheTtl' => [ - 'description' => 'Edge cache expiration time, in seconds.', - 'type' => 'string', - 'example' => '300', - 'title' => '', - ], - 'EdgeStatusCodeCacheTtl' => [ - 'description' => 'Status code cache expiration time, in seconds.', - 'type' => 'string', - 'example' => '4xx=10', - 'title' => '', - ], - 'SortQueryStringForCache' => [ - 'description' => 'Query string sorting. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'QueryStringMode' => [ - 'description' => 'The processing mode for query strings when generating cache keys. Value range:'."\n" - ."\n" - .'- ignore_all: Ignore all.'."\n" - .'- exclude_query_string: Exclude specified query strings.'."\n" - .'- reserve_all: Default, reserve all.'."\n" - .'- include_query_string: Include specified query strings.', - 'type' => 'string', - 'example' => 'reserve_all', - 'title' => '', - ], - 'QueryString' => [ - 'description' => 'The query strings to be retained or deleted, supporting multiple values separated by spaces.', - 'type' => 'string', - 'example' => 'example', - 'title' => '', - ], - 'IncludeHeader' => [ - 'description' => 'When generating the cache key, include the specified header names and their values. Supports multiple values, separated by spaces.', - 'type' => 'string', - 'example' => 'example', - 'title' => '', - ], - 'IncludeCookie' => [ - 'description' => 'When generating the cache key, include the specified cookie names and their values. Supports multiple values, separated by spaces.', - 'type' => 'string', - 'example' => 'cookie_exapmle', - 'title' => '', - ], - 'CacheReserveEligibility' => [ - 'description' => 'Cache reserve eligibility. Used to control whether user requests bypass the cache reserve node when returning to the origin. Value range:'."\n" - ."\n" - .'- bypass_cache_reserve: Requests bypass the cache reserve.'."\n" - .'- eligible_for_cache_reserve: Eligible for cache reserve.', - 'type' => 'string', - 'example' => 'bypass_cache_reserve', - 'title' => '', - ], - 'CheckPresenceHeader' => [ - 'description' => 'When generating the cache key, check if the header exists. If it does, add the header name (header names are case-insensitive) to the cache key. Supports multiple header names, separated by spaces.', - 'type' => 'string', - 'example' => 'headername', - 'title' => '', - ], - 'CheckPresenceCookie' => [ - 'description' => 'When generating the cache key, check if the cookie exists. If it does, add the cookie name (cookie names are case-insensitive) to the cache key. Supports multiple cookie names, separated by spaces.', - 'type' => 'string', - 'example' => 'cookiename', - 'title' => '', - ], - 'UserDeviceType' => [ - 'description' => 'When generating the cache key, include the client device type. Value range:'."\n" - ."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'UserGeo' => [ - 'description' => 'When generating the cache key, include the client\'s geographic location. Value range:'."\n" - ."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'UserLanguage' => [ - 'description' => 'When generating the cache key, include the client\'s language type. Value range:'."\n" - ."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'ServeStale' => [ - 'description' => 'Serve stale cache. When enabled, the node can still use the cached expired files to respond to user requests even if the origin server is unavailable. Value range:'."\n" - ."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'AdditionalCacheablePorts' => [ - 'description' => 'Enable caching on the specified ports. Value range: 8880, 2052, 2082, 2086, 2095, 2053, 2083, 2087, 2096.', - 'type' => 'string', - 'example' => '2095', - 'title' => '', - ], - 'CacheDeceptionArmor' => [ - 'description' => 'Cache deception defense. Used to defend against web cache deception attacks. Only the verified cache content will be cached. Value range:'."\n" - ."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'PostCache' => [ - 'description' => 'Post cache feature toggle.', - 'title' => 'Toggle for the Post cache feature.', - 'type' => 'string', - 'example' => 'on', - ], - 'PostBodyCacheKey' => [ - 'description' => 'Processing pattern for the cache key.', - 'title' => 'Processing pattern for the cache key.', - 'type' => 'string', - 'example' => 'ignore', - ], - 'PostBodySizeLimit' => [ - 'description' => 'Body size limit. The value is numeric, in KB. Body sizes from 1 KB to 8 KB are supported. If the value is empty, it defaults to 8 KB.', - 'type' => 'string', - 'example' => '1', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '64D28B53-5902-409B-94F6-FD46680144FE', 'title' => ''], + 'Tip' => ['description' => 'A diagnostic message.', 'type' => 'string', 'example' => 'Origin IP x.x.x.x: Test URL returned HTTP 404 (non-2xx status).'."\n" + .'Origin IP x.x.x.x: DNS A record does not point to an ESA service IP.', 'title' => ''], + 'Url' => ['description' => 'The generated diagnostic link.', 'type' => 'string', 'example' => 'http://cdn.dns-detect.alicdn.com/diagnose_v2?id=5d97ac9b&token=WFji65gy2mGNM11bD929%2BCMoyI6mbk2deRR9hOC6INH%2FoYbccQZQcvEn4wc%2FDPHlTshxRSAa5HokX%2BabItBpJ0FdnteROssomXqgIdjHpM46L%2BbaIeweZfsWG6QnbXT5n7O5APMyc%2Fe8d1o9PwwB429Ccks1FU1AfjNZfvBcLeo%3D', 'title' => ''], ], + 'title' => '', + 'description' => 'Response schema', 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - ], - ], - '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' => 'Query Site Cache Configuration', + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GenerateTraceDiagnose', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetCacheRule', - ], - ], + 'flowControlList' => [], ], 'ramActions' => [ [ - 'operationType' => 'get', + 'operationType' => 'none', 'ramAction' => [ - 'action' => 'esa:GetCacheRule', - 'authLevel' => 'resource', + 'action' => 'esa:GenerateTraceDiagnose', + 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"64D28B53-5902-409B-94F6-FD46680144FE\\",\\n \\"Tip\\": \\"Origin IP x.x.x.x: Test URL returned HTTP 404 (non-2xx status).\\\\nOrigin IP x.x.x.x: DNS A record does not point to an ESA service IP.\\",\\n \\"Url\\": \\"http://cdn.dns-detect.alicdn.com/diagnose_v2?id=5d97ac9b&token=WFji65gy2mGNM11bD929%2BCMoyI6mbk2deRR9hOC6INH%2FoYbccQZQcvEn4wc%2FDPHlTshxRSAa5HokX%2BabItBpJ0FdnteROssomXqgIdjHpM46L%2BbaIeweZfsWG6QnbXT5n7O5APMyc%2Fe8d1o9PwwB429Ccks1FU1AfjNZfvBcLeo%3D\\"\\n}","type":"json"}]', ], - 'GetCacheTag' => [ - 'summary' => 'Query Site Cache Tag Configuration', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetApiSchemaUsage' => [ + 'summary' => 'Retrieves usage information for an API schema validation plan.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '257339', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdnOKX321'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can obtain this ID by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1159101787****', 'title' => ''], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Version number of the site.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The site version.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The data returned for the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792', - ], - 'CaseInsensitive' => [ - 'description' => 'Whether to ignore case. Possible values:'."\n" - .'- on: Enabled, ignores case.'."\n" - .'- off: Disabled, does not ignore case.', - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '952ea16b-1f05-4a76-bb32-420282d8****'], + 'InstanceId' => ['description' => 'The plan\'s instance ID.', 'type' => 'string', 'example' => 'esa-site-agknce3n****', 'title' => ''], + 'InstanceUsage' => ['description' => 'The total count of API schema files uploaded to the plan instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Usages' => [ + 'description' => 'The usage details for each site.', + 'type' => 'array', + 'items' => [ + 'description' => 'The usage details for an individual site.', + 'type' => 'object', + 'properties' => [ + 'Usage' => ['description' => 'The number of API schema files uploaded for this site.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Id' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '40000449', 'title' => ''], + 'Name' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'example' => 'on', - 'title' => '', - ], - 'TagName' => [ - 'description' => 'Custom CacheTag name.', - 'type' => 'string', - 'example' => 'example', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'Version number of the site.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', 'title' => '', + 'example' => '', ], ], 'example' => '', @@ -36250,58 +20245,37 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter.ApiShield.Quota', 'errorMessage' => 'This website does not have the permission to view API security features.', 'description' => 'This website does not have the permission to view API security features.'], + ['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' => '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.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"156A6B-677B1A-4297B7-9187B7-2B44792\\",\\n \\"CaseInsensitive\\": \\"on\\",\\n \\"TagName\\": \\"example\\",\\n \\"SiteVersion\\": 1\\n}","type":"json"}]', - 'title' => 'Query Site Cache Tag Configuration', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetApiSchemaUsage', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetCacheTag', - ], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApiSchemaUsage'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ - 'action' => 'esa:GetCacheTag', + 'action' => 'esa:GetApiSchemaUsage', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'operationType' => 'read', + '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"}]', ], - 'GetCertificate' => [ - 'summary' => 'Retrieve the certificate, private key, and certificate information', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetAutomaticFrequencyControlConfig' => [ + 'summary' => 'Queries the automatic frequency control configuration for a site.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -36310,353 +20284,111 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '239130', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeCode' => '253995', + 'abilityTreeNodes' => ['FEATUREdcdnUTRW1O'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the site. Call the [ListSites](~~2850189~~) operation to obtain this ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Certificate ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'babaded901474b9693acf530e0fb1d95', - 'title' => '', - ], + 'schema' => ['description' => 'The version of the site. If versioning is enabled, use this parameter to specify the site version. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'SiteId' => [ - 'description' => 'Site ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567890123', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'Site name.', - 'type' => 'string', - 'example' => 'example.com ', - 'title' => '', - ], - 'Status' => [ - 'description' => 'Certificate status.', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'], + 'Enable' => [ + 'description' => 'Indicates whether automatic frequency control is enabled. Valid values:'."\n" + ."\n" + .'- **on**: Enabled.'."\n" + ."\n" + .'- **off**: Disabled.', + 'enumValueTitles' => ['off' => 'off', 'on' => 'on'], 'type' => 'string', - 'example' => 'OK', + 'example' => 'on', 'title' => '', ], - 'Certificate' => [ - 'description' => 'Certificate content.', + 'Level' => [ + 'description' => 'The protection level. Valid values:'."\n" + ."\n" + .'- **loose**: Loose.'."\n" + ."\n" + .'- **normal**: Normal.'."\n" + ."\n" + .'- **strict**: Strict.', + 'enumValueTitles' => ['normal' => 'normal', 'loose' => 'loose', 'strict' => 'strict'], 'type' => 'string', - 'example' => '-----BEGIN CERTIFICATE-----', - 'title' => '', - ], - 'Result' => [ - 'description' => 'The certificate information.'."\n", - 'type' => 'object', - 'properties' => [ - 'CasId' => [ - 'description' => 'Cloud certificate ID.', - 'type' => 'string', - 'example' => '30000478', - 'title' => '', - ], - 'Id' => [ - 'description' => 'Certificate ID.', - 'type' => 'string', - 'example' => 'babaded901474b9693acf530e0fb1d95', - 'title' => '', - ], - 'Name' => [ - 'description' => 'Certificate name.', - 'type' => 'string', - 'example' => 'yourCertName', - 'title' => '', - ], - 'Region' => [ - 'description' => 'Region.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - 'title' => '', - ], - 'Status' => [ - 'description' => 'Certificate status.', - 'type' => 'string', - 'example' => 'OK', - 'title' => '', - ], - 'Type' => [ - 'description' => 'Certificate type.', - 'type' => 'string', - 'example' => 'free', - 'enumValueTitles' => [ - 'cas' => '云盾证书', - 'upload' => '自定义上传证书', - 'keyless' => 'Keyless证书', - 'free' => '免费证书', - ], - 'title' => '', - ], - 'CommonName' => [ - 'description' => 'Common Name (CN) field of the certificate.', - 'type' => 'string', - 'example' => 'www.example.com', - 'title' => '', - ], - 'NotBefore' => [ - 'description' => 'Start time of the certificate validity period.', - 'type' => 'string', - 'example' => '2023-11-26T16:00:00Z', - 'title' => '', - ], - 'NotAfter' => [ - 'description' => 'End time of the certificate validity period.', - 'type' => 'string', - 'example' => '2023-11-26T16:00:00Z', - 'title' => '', - ], - 'Issuer' => [ - 'description' => 'Certificate issuer.', - 'type' => 'string', - 'example' => 'DigiCert', - 'title' => '', - ], - 'IssuerCN' => [ - 'description' => 'Certificate issuing authority.', - 'type' => 'string', - 'example' => 'DigiCert Global Root CA', - 'title' => '', - ], - 'SAN' => [ - 'description' => 'Subject Alternative Name (SAN) of the certificate.', - 'type' => 'string', - 'example' => 'www.example.com,*.example.com', - 'title' => '', - ], - 'SigAlg' => [ - 'description' => 'Certificate signature algorithm.', - 'type' => 'string', - 'example' => 'ECDSA-SHA1', - 'title' => '', - ], - 'PubAlg' => [ - 'description' => 'Certificate public key algorithm.', - 'type' => 'string', - 'example' => 'ECDSA', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'Creation time.', - 'type' => 'string', - 'example' => '2020-05-12 02:00:53', - 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'Update time.', - 'type' => 'string', - 'example' => '2022-09-22 05:33:13', - 'title' => '', - ], - 'SerialNumber' => [ - 'description' => 'Serial number of the certificate.', - 'type' => 'string', - 'example' => 'babaded901474b9693acf530e0fb1daa', - 'title' => '', - ], - 'FingerprintSha256' => [ - 'description' => 'SHA256 fingerprint of the certificate.', - 'type' => 'string', - 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66', - 'title' => '', - ], - 'DCV' => [ - 'description' => 'The Domain Control Validation (DCV) information.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The DCV ID.'."\n", - 'type' => 'string', - 'example' => 'bababf7cdd1546a2ad04c0def1f4c980', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The DCV type. Valid values: DNS and HTTP.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'DNS' => 'DNS', - 'HTTP' => 'HTTP', - ], - 'example' => 'HTTP', - 'title' => '', - ], - 'Key' => [ - 'description' => 'The DCV name. It is a TXT record name if Type is DNS or URL if Type is HTTP.'."\n", - 'type' => 'string', - 'example' => 'http://www.example.com/.well-known/acme-challenge/pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow', - 'title' => '', - ], - 'Value' => [ - 'description' => 'The DCV content.'."\n", - 'type' => 'string', - 'example' => 'pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow.KfzYo4LH3EgOt7a73G-RqZkbR0eYtLfEUmtmqGmr4FQ', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The verification status.'."\n", - 'type' => 'string', - 'example' => 'pending', - 'title' => '', - ], - ], - 'description' => 'DCV information.', - 'title' => '', - 'example' => '', - ], - 'title' => '', - 'example' => '', - ], - 'ApplyCode' => [ - 'description' => 'The error code returned for certificate application.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - 'title' => '', - ], - 'ApplyMessage' => [ - 'description' => 'The error message returned for certificate application.'."\n", - 'type' => 'string', - 'example' => 'canceled', - 'title' => '', - ], - 'KeyServerId' => [ - 'description' => 'Keyless server ID, valid when Type is keyless.', - 'type' => 'string', - 'example' => 'baba39055622c008b90285a8838e****', - 'title' => '', - ], - ], + 'example' => 'normal', 'title' => '', - 'example' => '', ], - 'RequestId' => [ - 'description' => 'Request ID.', + 'ActionType' => [ + 'description' => 'The action to perform. Valid values:'."\n" + ."\n" + .'- **observe**: Monitors requests.'."\n" + ."\n" + .'- **deny**: Denies requests.'."\n" + ."\n" + .'- **js**: Issues a JavaScript challenge.', + 'enumValueTitles' => ['deny' => 'deny', 'js' => 'js', 'observe' => 'observe'], 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + 'example' => 'js', 'title' => '', ], + 'RuleId' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11957665', 'title' => ''], + 'Threshold' => ['description' => 'The threshold that triggers the action.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'Interval' => ['description' => 'The statistics collection interval.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PunishTime' => ['description' => 'The duration of the penalty, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '20000000', 'title' => ''], ], + 'title' => '', + 'description' => 'The response body.', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'Id.MissingParameter', - 'errorMessage' => 'The parameter Id is required.', - 'description' => 'The required parameter Id is missing.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], ], - [ - [ - 'errorCode' => 'Certificate.NotFound', - 'errorMessage' => 'The specified certificate does not exist.', - 'description' => 'The specified certificate does not exist.', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - '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' => 'Get Specified Certificate Information', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetAutomaticFrequencyControlConfig', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetCertificate', - ], - ], + 'flowControlList' => [], ], 'ramActions' => [ [ - 'operationType' => 'list', + 'operationType' => 'none', 'ramAction' => [ - 'action' => 'esa:GetCertificate', + 'action' => 'esa:GetAutomaticFrequencyControlConfig', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'translator' => 'machine', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Enable\\": \\"on\\",\\n \\"Level\\": \\"normal\\",\\n \\"ActionType\\": \\"js\\",\\n \\"RuleId\\": 11957665,\\n \\"Threshold\\": 100,\\n \\"Interval\\": 10,\\n \\"PunishTime\\": 20000000\\n}","type":"json"}]', ], - 'GetCertificateQuota' => [ - 'summary' => 'Query certificate quota and usage', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetCacheReserveSpecification' => [ + 'summary' => 'Queries the available specifications of cache reserve instances.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -36665,109 +20397,32 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '238965', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], - ], - 'parameters' => [ - [ - 'name' => 'SiteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'Certificate Quota type.', - 'type' => 'string', - 'required' => true, - 'example' => 'free', - 'title' => '', - ], - ], + 'abilityTreeCode' => '239117', + 'abilityTreeNodes' => ['FEATUREdcdn51XOHW'], ], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Details of the request response.', 'type' => 'object', 'properties' => [ - 'Quota' => [ - 'description' => 'Free certificate quota.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - 'title' => '', - ], - 'QuotaUsage' => [ - 'description' => 'Usage of free certificate quota.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - 'title' => '', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - 'title' => '', - ], - 'Type' => [ - 'description' => 'Certificate Quota type.', - 'type' => 'string', - 'example' => 'free', - 'title' => '', - ], - 'SiteCount' => [ - 'description' => 'Number of sites.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n"], + 'CacheReserveRegion' => [ + 'description' => 'List of cache retention region specifications.', + 'type' => 'array', + 'items' => ['description' => 'Details of the region.', 'type' => 'string', 'example' => 'HK', 'title' => ''], 'title' => '', + 'example' => '', ], - 'SiteUsage' => [ - 'description' => 'List of site usage details.', + 'CacheReserveCapacity' => [ + 'description' => 'List of cache retention capacity specifications.', 'type' => 'array', - 'items' => [ - 'description' => 'Details of site usage.', - 'type' => 'object', - 'properties' => [ - 'SiteId' => [ - 'description' => 'Site ID.', - 'type' => 'string', - 'example' => '165929521496928', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'Site name.', - 'type' => 'string', - 'example' => 'example.com ', - 'title' => '', - ], - 'SiteUsage' => [ - 'description' => 'Site usage.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - 'title' => '', - ], - ], - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'Details of the capacity specification. Unit: GB.', 'type' => 'string', 'example' => '512000', 'title' => ''], 'title' => '', 'example' => '', ], @@ -36778,60 +20433,28 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed', - 'errorMessage' => 'Failed to check free certificate Quota, please try again later.', - 'description' => 'Failed to check free certificate Quota, please try again later.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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"}]', - 'title' => 'GetCertificateQuota', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\\\n\\",\\n \\"CacheReserveRegion\\": [\\n \\"HK\\"\\n ],\\n \\"CacheReserveCapacity\\": [\\n \\"512000\\"\\n ]\\n}","type":"json"}]', + 'title' => 'GetCacheReserveSpecification', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetCertificateQuota', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCacheReserveSpecification'], ], ], 'ramActions' => [ [ - 'operationType' => 'list', + 'operationType' => 'get', 'ramAction' => [ - 'action' => 'esa:GetCertificateQuota', - 'authLevel' => 'resource', + 'action' => 'esa:GetCacheReserveSpecification', + 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -36841,14 +20464,10 @@ 'eventNames' => [], ], ], - 'GetClientCaCertificate' => [ - 'summary' => 'Queries a client CA certificate.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetCacheRule' => [ + 'summary' => 'Retrieves a single cache configuration.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -36860,172 +20479,246 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '238932', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeCode' => '257574', + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. Call the [ListSites](~~2850189~~) operation to obtain this ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The certificate ID, which can be obtained by calling the [ListClientCaCertificates](~~2860651~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'babab9db65ee5efcca9f3d41d4b5****', - 'title' => '', + 'schema' => ['description' => 'The configuration ID. Call the [ListCacheRules](~~2866985~~) operation to obtain this ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '352816096987136', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '352816096987136', 'title' => ''], + 'ConfigType' => ['description' => 'Indicates whether the response contains a global or a rule configuration. Valid values:'."\n" + ."\n" + .'- `global`: A global configuration.'."\n" + ."\n" + .'- `rule`: A rule configuration.', 'type' => 'string', 'example' => 'global', 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the site configuration. For sites with version management enabled, this indicates the configuration version. The default is 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Sequence' => ['description' => 'The rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuleEnable' => ['description' => 'Specifies whether the rule is enabled. This parameter applies only to rule configurations. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'The rule content, which is a conditional expression used to match user requests. This parameter applies only to rule configurations.'."\n" + ."\n" + .'- To match all incoming requests, use `true`.'."\n" + ."\n" + .'- To match specific requests, use a custom expression, such as `(http.host eq "video.example.com")`.', 'type' => 'string', 'example' => '(http.host eq \\"video.example.com\\")'."\n", 'title' => ''], + 'RuleName' => ['description' => 'The name of the rule. This parameter applies only to rule configurations.', 'type' => 'string', 'example' => 'rule_example'."\n", 'title' => ''], + 'BypassCache' => ['description' => 'Specifies whether to cache requests or bypass the cache. Valid values:'."\n" + ."\n" + .'- `cache_all`: Caches all requests.'."\n" + ."\n" + .'- `bypass_all`: Bypasses the cache for all requests.', 'type' => 'string', 'example' => 'cache_all', 'title' => ''], + 'BrowserCacheMode' => ['description' => 'The browser cache mode. Valid values:'."\n" + ."\n" + .'- `no_cache`: Does not cache content.'."\n" + ."\n" + .'- `follow_origin`: Follows the origin cache policy.'."\n" + ."\n" + .'- `override_origin`: Overrides the origin cache policy.', 'type' => 'string', 'example' => 'follow_origin', 'title' => ''], + 'BrowserCacheTtl' => ['description' => 'The browser cache TTL, in seconds.', 'type' => 'string', 'example' => '300', 'title' => ''], + 'EdgeCacheMode' => ['description' => 'The edge cache mode. Valid values:'."\n" + ."\n" + .'- `follow_origin`: Uses the origin server\'s cache policy. If none is provided, the default policy applies.'."\n" + ."\n" + .'- `no_cache`: Does not cache content.'."\n" + ."\n" + .'- `override_origin`: Overrides the origin cache policy.'."\n" + ."\n" + .'- `follow_origin_bypass`: Uses the origin server\'s cache policy. If none is provided, content is not cached.'."\n" + ."\n" + .'- `follow_origin_override`: Uses the origin server\'s cache policy. If none is provided, a custom cache TTL applies.', 'type' => 'string', 'example' => 'follow_origin', 'title' => ''], + 'EdgeCacheTtl' => ['description' => 'The edge cache TTL, in seconds.', 'type' => 'string', 'example' => '300', 'title' => ''], + 'EdgeStatusCodeCacheTtl' => ['description' => 'The status code cache TTL, in seconds.'."\n" + ."\n" + .'- Set the cache TTL for a specific status code. For example, `404=10` specifies that responses with a 404 status code are cached for 10 seconds.'."\n" + ."\n" + .'- Set the cache TTL for status code classes, such as 4xx and 5xx. For example, `4xx=10` specifies that all responses with a 4xx status code are cached for 10 seconds.'."\n" + ."\n" + .'- Separate multiple entries with commas.', 'type' => 'string', 'example' => '5xx=0,404=10', 'title' => ''], + 'SortQueryStringForCache' => ['description' => 'Specifies whether to sort query strings before generating the cache key. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'QueryStringMode' => ['description' => 'The mode for handling query strings when generating a cache key. Valid values:'."\n" + ."\n" + .'- `ignore_all`: Ignores all query strings.'."\n" + ."\n" + .'- `exclude_query_string`: Excludes specified query strings.'."\n" + ."\n" + .'- `reserve_all`: Retains all query strings. This is the default value.'."\n" + ."\n" + .'- `include_query_string`: Includes specified query strings.', 'type' => 'string', 'example' => 'reserve_all', 'title' => ''], + 'QueryString' => ['description' => 'Specifies the query strings to include in or exclude from the cache key. Separate multiple query strings with spaces.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'IncludeHeader' => ['description' => 'Specifies the headers to include in the cache key. Both the header names (case-insensitive) and their values are added to the key. Separate multiple header names with spaces. Header names can contain the following characters:'."\n" + ."\n" + .'- Symbols: ! # $ % & \' \\* + - . ^ \\_ | \\~'."\n" + ."\n" + .'- Digits: 0-9'."\n" + ."\n" + .'- Letters: lowercase English letters a-z', 'type' => 'string', 'example' => 'headername1 headername2', 'title' => ''], + 'IncludeCookie' => ['description' => 'Specifies the cookies to include in the cache key. Both the cookie names (case-insensitive) and their values are added to the key. Separate multiple cookie names with spaces. Cookie names can contain the following characters:'."\n" + ."\n" + .'- Symbols: ! # $ % & \' \\* + - . ^ \\_ | \\~'."\n" + ."\n" + .'- Digits: 0-9'."\n" + ."\n" + .'- Letters: lowercase English letters a-z', 'type' => 'string', 'example' => 'cookiename1 cookiename2', 'title' => ''], + 'CacheReserveEligibility' => ['description' => 'The eligibility for cache reserve. This controls whether a request bypasses the cache reserve node during an origin fetch. Valid values:'."\n" + ."\n" + .'- `bypass_cache_reserve`: The request bypasses the cache reserve.'."\n" + ."\n" + .'- `eligible_for_cache_reserve`: The request is eligible for cache reserve.', 'type' => 'string', 'example' => 'bypass_cache_reserve', 'title' => ''], + 'CheckPresenceHeader' => ['description' => 'Specifies headers whose presence is checked when generating a cache key. If a specified header exists in the request, its name (case-insensitive) is added to the cache key. Separate multiple header names with spaces. Header names can contain the following characters:'."\n" + ."\n" + .'- Symbols: ! # $ % & \' \\* + - . ^ \\_ | \\~'."\n" + ."\n" + .'- Digits: 0-9'."\n" + ."\n" + .'- Letters: lowercase English letters a-z', 'type' => 'string', 'example' => 'headername1 headername2', 'title' => ''], + 'CheckPresenceCookie' => ['description' => 'Specifies cookies whose presence is checked when generating a cache key. If a specified cookie exists in the request, its name (case-insensitive) is added to the cache key. Separate multiple cookie names with spaces. Cookie names can contain the following characters:'."\n" + ."\n" + .'- Symbols: ! # $ % & \' \\* + - . ^ \\_ | \\~'."\n" + ."\n" + .'- Digits: 0-9'."\n" + ."\n" + .'- Letters: lowercase English letters a-z', 'type' => 'string', 'example' => 'cookiename1 cookiename2', 'title' => ''], + 'UserDeviceType' => ['description' => 'Specifies whether to include the client\'s device type in the cache key. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'UserGeo' => ['description' => 'Specifies whether to include the client\'s geographic location in the cache key. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'UserLanguage' => ['description' => 'Specifies whether to include the client\'s language in the cache key. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'ServeStale' => ['description' => 'Specifies whether to serve stale content. If enabled, edge nodes serve stale (expired) content from the cache when the origin server is unavailable. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'AdditionalCacheablePorts' => ['description' => '- Additional ports on which caching is enabled.'."\n" + ."\n" + .'- Valid values: `8880`, `2052`, `2082`, `2086`, `2095`, `2053`, `2083`, `2087`, `2096`.'."\n" + ."\n" + .'- Separate multiple ports with commas.', 'type' => 'string', 'example' => '8880,2052,2086', 'title' => ''], + 'CacheDeceptionArmor' => ['description' => 'Specifies whether to enable Cache Deception Armor. This feature helps mitigate web cache deception attacks by ensuring that only validated content is cached. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'PostCache' => ['title' => 'Toggle for the Post cache feature.', 'description' => 'Specifies whether to enable the POST cache feature.', 'type' => 'string', 'example' => 'on'], + 'PostBodyCacheKey' => ['title' => 'Processing pattern for the cache key.', 'description' => 'The mode for handling the body content when generating a cache key for POST requests. Valid values:'."\n" + ."\n" + .'- `md5`: Calculates the MD5 hash of the body content and adds the hash to the cache key.'."\n" + ."\n" + .'- `ignore`: Ignores the body content in the cache key.', 'type' => 'string', 'example' => 'ignore'], + 'PostBodySizeLimit' => ['description' => 'The size limit (in KB) of the body content for POST caching. The value is an integer from 1 to 8. A null or empty value defaults to 8 KB.', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ], + ], + '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\\": \\"5xx=0,404=10\\",\\n \\"SortQueryStringForCache\\": \\"on\\",\\n \\"QueryStringMode\\": \\"reserve_all\\",\\n \\"QueryString\\": \\"example\\",\\n \\"IncludeHeader\\": \\"headername1 headername2\\",\\n \\"IncludeCookie\\": \\"cookiename1 cookiename2\\",\\n \\"CacheReserveEligibility\\": \\"bypass_cache_reserve\\",\\n \\"CheckPresenceHeader\\": \\"headername1 headername2\\",\\n \\"CheckPresenceCookie\\": \\"cookiename1 cookiename2\\",\\n \\"UserDeviceType\\": \\"on\\",\\n \\"UserGeo\\": \\"on\\",\\n \\"UserLanguage\\": \\"on\\",\\n \\"ServeStale\\": \\"on\\",\\n \\"AdditionalCacheablePorts\\": \\"8880,2052,2086\\",\\n \\"CacheDeceptionArmor\\": \\"on\\",\\n \\"PostCache\\": \\"on\\",\\n \\"PostBodyCacheKey\\": \\"ignore\\",\\n \\"PostBodySizeLimit\\": \\"1\\"\\n}","type":"json"}]', + 'title' => 'Query Site Cache Configuration', + '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' => [ + 'summary' => 'Query Site Cache Tag Configuration', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257339', + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => ['description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => ['description' => 'Version number of the site.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567890123', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The certificate status.'."\n", - 'type' => 'string', - 'example' => 'OK', - 'title' => '', - ], - 'Certificate' => [ - 'description' => 'The certificate content.'."\n", - 'type' => 'string', - 'example' => '-----BEGIN CERTIFICATE-----', - 'title' => '', - ], - 'Result' => [ - 'description' => 'The certificate information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'example' => 'babab9db65ee5efcca9f3d41d4b5****', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The certificate name.'."\n", - 'type' => 'string', - 'example' => 'yourCertName', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The certificate status.'."\n", - 'type' => 'string', - 'example' => 'OK', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The certificate type.'."\n", - 'type' => 'string', - 'example' => 'upload', - 'title' => '', - ], - 'CommonName' => [ - 'description' => 'The Common Name of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com ', - 'title' => '', - ], - 'NotBefore' => [ - 'description' => 'The time when the certificate takes effect.'."\n", - 'type' => 'string', - 'example' => '2023-03-31 02:08:00', - 'title' => '', - ], - 'NotAfter' => [ - 'description' => 'The time when the certificate expires.'."\n", - 'type' => 'string', - 'example' => '2024-03-31 02:08:00', - 'title' => '', - ], - 'Issuer' => [ - 'description' => 'The certificate authority (CA) that issued the certificate.'."\n", - 'type' => 'string', - 'example' => 'GlobalSign nv-sa', - 'title' => '', - ], - 'SAN' => [ - 'description' => 'The Subject Alternative Name (SAN) of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com,*.example.com', - 'title' => '', - ], - 'SignatureAlgorithm' => [ - 'description' => 'The signature algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'SHA256-RSA', - 'title' => '', - ], - 'PubkeyAlgorithm' => [ - 'description' => 'The public-key algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'RSA', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the certificate was created.'."\n", - 'type' => 'string', - 'example' => '2024-03-05 18:24:04', - 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'The time when the certificate was updated.'."\n", - 'type' => 'string', - 'example' => '2024-03-05 18:24:04', - 'title' => '', - ], - 'SerialNumber' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'FingerprintSha256' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - 'title' => '', - 'example' => '', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792'], + 'CaseInsensitive' => [ + 'description' => 'Whether to ignore case. Possible values:'."\n" + .'- on: Enabled, ignores case.'."\n" + .'- off: Disabled, does not ignore case.', 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', + 'enumValueTitles' => ['off' => 'off', 'on' => 'on'], + 'example' => 'on', 'title' => '', ], + 'TagName' => ['description' => 'Custom CacheTag name.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'SiteVersion' => ['description' => 'Version number of the site.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'example' => '', ], @@ -37033,100 +20726,37 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'Id.MissingParameter', - 'errorMessage' => 'The parameter Id is required.', - 'description' => 'The required parameter Id is missing.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], - ], - [ - [ - 'errorCode' => 'Certificate.NotFound', - 'errorMessage' => 'The specified certificate does not exist.', - 'description' => 'The specified certificate does not exist.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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"}]', - 'title' => 'GetClientCaCertificate', - 'changeSet' => [ - [ - 'createdAt' => '2025-03-12T03:30:13.000Z', - 'description' => 'Response parameters changed', + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"156A6B-677B1A-4297B7-9187B7-2B44792\\",\\n \\"CaseInsensitive\\": \\"on\\",\\n \\"TagName\\": \\"example\\",\\n \\"SiteVersion\\": 1\\n}","type":"json"}]', + 'title' => 'Query Site Cache Tag Configuration', + 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetClientCaCertificate', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCacheTag'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ - 'action' => 'esa:GetClientCaCertificate', + 'action' => 'esa:GetCacheTag', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], + 'operationType' => 'read', ], - 'GetClientCertificate' => [ - 'summary' => 'Queries information about a client certificate.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetCertificate' => [ + 'summary' => 'Retrieves information about a specified certificate for a site.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -37135,181 +20765,96 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '238926', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeCode' => '239130', + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to query the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'baba39055622c008b90285a8838ed09a', - 'title' => '', - ], + 'schema' => ['description' => 'The certificate ID.', 'type' => 'string', 'required' => true, 'example' => 'babaded901474b9693acf530e0fb1d95', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567890123', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com'."\n", - 'title' => '', - ], - 'Status' => [ - 'description' => 'The certificate status.'."\n", - 'type' => 'string', - 'example' => 'active', - 'title' => '', - ], - 'Certificate' => [ - 'description' => 'The certificate content.'."\n", - 'type' => 'string', - 'example' => '-----BEGIN CERTIFICATE-----', - 'title' => '', - ], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com ', 'title' => ''], + 'Status' => ['description' => 'The certificate status.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Certificate' => ['description' => 'The certificate content.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----', 'title' => ''], 'Result' => [ - 'description' => 'The certificate information.'."\n", + 'description' => 'The certificate information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'example' => 'baba39055622c008b90285a8838ed09a', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The certificate name.'."\n", - 'type' => 'string', - 'example' => 'yourCertName', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The certificate status.'."\n", - 'type' => 'string', - 'example' => 'active', - 'title' => '', - ], + 'CasId' => ['description' => 'The cloud certificate ID.', 'type' => 'string', 'example' => '30000478', 'title' => ''], + 'Id' => ['description' => 'The certificate ID.', 'type' => 'string', 'example' => 'babaded901474b9693acf530e0fb1d95', 'title' => ''], + 'Name' => ['description' => 'The certificate name.', 'type' => 'string', 'example' => 'yourCertName', 'title' => ''], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Status' => ['description' => 'The certificate status.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Type' => [ - 'description' => 'The certificate type.'."\n", - 'type' => 'string', - 'example' => 'dcdn', - 'title' => '', - ], - 'CommonName' => [ - 'description' => 'The Common Name of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com ', - 'title' => '', - ], - 'NotBefore' => [ - 'description' => 'The time when the certificate takes effect.'."\n", - 'type' => 'string', - 'example' => '2023-03-31 02:08:00', - 'title' => '', - ], - 'NotAfter' => [ - 'description' => 'The time when the certificate expires.'."\n", - 'type' => 'string', - 'example' => '2024-03-31 02:08:00', - 'title' => '', - ], - 'Issuer' => [ - 'description' => 'The certificate authority (CA) that issued the certificate.'."\n", - 'type' => 'string', - 'example' => 'GlobalSign nv-sa', - 'title' => '', - ], - 'SAN' => [ - 'description' => 'The Subject Alternative Name (SAN) of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com,*.example.com', - 'title' => '', - ], - 'SignatureAlgorithm' => [ - 'description' => 'The signature algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'SHA256-RSA', - 'title' => '', - ], - 'PubkeyAlgorithm' => [ - 'description' => 'The public-key algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'RSA', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the certificate was created.'."\n", - 'type' => 'string', - 'example' => '2024-06-24 07:48:51', - 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'The time when the certificate was updated.'."\n", - 'type' => 'string', - 'example' => '2024-09-22 05:33:13', - 'title' => '', - ], - 'CACertificateId' => [ - 'description' => 'The ID of the CA certificate.'."\n", - 'type' => 'string', - 'example' => 'babab9db65ee5efcca9f3d41d4b50d66', - 'title' => '', - ], - 'SerialNumber' => [ + 'description' => 'The certificate type.', + 'enumValueTitles' => ['cas' => 'SSL Certificates Service certificate.', 'upload' => 'custom uploaded certificate.', 'keyless' => 'Keyless certificate.', 'free' => 'free certificate.'], 'type' => 'string', - 'description' => '', + 'example' => 'free', 'title' => '', - 'example' => '', ], - 'FingerprintSha256' => [ - 'type' => 'string', - 'description' => '', + 'CommonName' => ['description' => 'The Common Name (CN) field of the certificate.', 'type' => 'string', 'example' => 'www.example.com', 'title' => ''], + 'NotBefore' => ['description' => 'The start time of the certificate validity period. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2026-07-01 06:26:47', 'title' => ''], + 'NotAfter' => ['description' => 'The end time of the certificate validity period. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2026-09-29 06:26:46', 'title' => ''], + 'Issuer' => ['description' => 'The certificate issuer.', 'type' => 'string', 'example' => 'DigiCert', 'title' => ''], + 'IssuerCN' => ['description' => 'The certification authority.', 'type' => 'string', 'example' => 'DigiCert Global Root CA', 'title' => ''], + 'SAN' => ['description' => 'The Subject Alternative Name (SAN) of the certificate.', 'type' => 'string', 'example' => 'www.example.com,*.example.com', 'title' => ''], + 'SigAlg' => ['description' => 'The signature algorithm of the certificate.', 'type' => 'string', 'example' => 'ECDSA-SHA1', 'title' => ''], + 'PubAlg' => ['description' => 'The public key algorithm of the certificate.', 'type' => 'string', 'example' => 'ECDSA', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2026-07-01 07:25:23', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2026-07-01 07:25:23', 'title' => ''], + 'SerialNumber' => ['description' => 'The certificate serial number.', 'type' => 'string', 'example' => 'babaded901474b9693acf530e0fb1daa', 'title' => ''], + 'FingerprintSha256' => ['description' => 'The SHA-256 fingerprint of the certificate.', 'type' => 'string', 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66', 'title' => ''], + 'DCV' => [ + 'description' => 'The Domain Control Validation (DCV) information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The Domain Control Validation (DCV) information.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'DCV ID。', 'type' => 'string', 'example' => 'bababf7cdd1546a2ad04c0def1f4c980', 'title' => ''], + 'Type' => [ + 'description' => 'The DCV type. Valid values: DNS and HTTP.', + 'enumValueTitles' => ['DNS' => 'DNS', 'HTTP' => 'HTTP'], + 'type' => 'string', + 'example' => 'HTTP', + 'title' => '', + ], + 'Key' => ['description' => 'The DCV name. For the DNS type, this is the TXT record name. For the HTTP type, this is the URL.', 'type' => 'string', 'example' => 'http://www.example.com/.well-known/acme-challenge/pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow', 'title' => ''], + 'Value' => ['description' => 'The DCV content.', 'type' => 'string', 'example' => 'pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow.KfzYo4LH3EgOt7a73G-RqZkbR0eYtLfEUmtmqGmr4FQ', 'title' => ''], + 'Status' => ['description' => 'The validation status.', 'type' => 'string', 'example' => 'pending', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], 'title' => '', 'example' => '', ], + 'ApplyCode' => ['description' => 'The error code of the certificate application.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'ApplyMessage' => ['description' => 'The error message of the certificate application.', 'type' => 'string', 'example' => 'canceled', 'title' => ''], + 'KeyServerId' => ['description' => 'The Keyless server ID. This parameter is valid only when Type is set to keyless.', 'type' => 'string', 'example' => 'baba39055622c008b90285a8838e****', 'title' => ''], ], 'title' => '', 'example' => '', ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', 'title' => ''], ], 'example' => '', ], @@ -37317,180 +20862,103 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'Id.MissingParameter', - 'errorMessage' => 'The parameter Id is required.', - 'description' => 'The required parameter Id is missing.', - ], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Id.MissingParameter', 'errorMessage' => 'The parameter Id is required.', 'description' => 'The required parameter Id is missing.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'Certificate.NotFound', - 'errorMessage' => 'The specified certificate does not exist.', - 'description' => 'The specified certificate does not exist.', - ], + ['errorCode' => 'Certificate.NotFound', 'errorMessage' => 'The specified certificate does not exist.', 'description' => 'The specified certificate does not exist.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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"}]', - 'title' => 'GetClientCertificate', - 'changeSet' => [ - [ - 'createdAt' => '2025-03-12T03:30:14.000Z', - 'description' => 'Response parameters changed', - ], + '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\\": \\"2026-07-01 06:26:47\\",\\n \\"NotAfter\\": \\"2026-09-29 06:26:46\\",\\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\\": \\"2026-07-01 07:25:23\\",\\n \\"UpdateTime\\": \\"2026-07-01 07:25:23\\",\\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"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + 'title' => 'Get specified certificate information', + 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetClientCertificate', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCertificate'], ], ], 'ramActions' => [ [ - 'operationType' => 'get', + 'operationType' => 'list', 'ramAction' => [ - 'action' => 'esa:GetClientCertificate', + 'action' => 'esa:GetCertificate', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], ], - 'GetClientCertificateHostnames' => [ - 'summary' => 'Queries domain names associated with a client CA certificate. If no certificate is specified, domain names associated with an Edge Security Acceleration(ESA)-managed CA certificate are returned.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetCertificateQuota' => [ + 'summary' => 'Queries the quota and usage of free certificates.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '239234', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeCode' => '238965', + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain this ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'baba39055622c008b90285a8838ed09a', - 'title' => '', - ], + 'schema' => ['description' => 'The certificate quota type.', 'type' => 'string', 'required' => true, 'example' => 'free', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567890123', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com'."\n", - 'title' => '', - ], - 'Id' => [ - 'description' => 'The ID of the client CA certificate.'."\n", - 'type' => 'string', - 'example' => 'baba39055622c008b90285a8838ed09a', - 'title' => '', - ], - 'Hostnames' => [ - 'description' => 'The domain names with which the certificate is associated.'."\n", + 'Quota' => ['description' => 'The free certificate quota.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'QuotaUsage' => ['description' => 'The number of used free certificates.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', 'title' => ''], + 'Type' => ['description' => 'The certificate quota type.', 'type' => 'string', 'example' => 'free', 'title' => ''], + 'SiteCount' => ['description' => 'The site count.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'SiteUsage' => [ + 'description' => 'Details about the certificate usage for each site.', 'type' => 'array', 'items' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'example' => 'www.example.com ', + 'description' => 'Certificate usage details for a site.', + 'type' => 'object', + 'properties' => [ + 'SiteId' => ['description' => 'The site ID.', 'type' => 'string', 'example' => '165929521496928', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com ', 'title' => ''], + 'SiteUsage' => ['description' => 'The number of certificates used by the site.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + ], 'title' => '', + 'example' => '', ], 'title' => '', 'example' => '', ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n", - 'title' => '', - ], ], 'example' => '', ], @@ -37498,137 +20966,106 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - ], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'QuotaCheckFailed', 'errorMessage' => 'Failed to check free certificate Quota, please try again later.', 'description' => 'Failed to check free certificate Quota, please try again later.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - '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"}]', - 'title' => 'GetClientCertificateHostnames', + 'title' => 'GetCertificateQuota', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetClientCertificateHostnames', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCertificateQuota'], ], ], 'ramActions' => [ [ - 'operationType' => 'get', + 'operationType' => 'list', 'ramAction' => [ - 'action' => 'esa:GetClientCertificateHostnames', + 'action' => 'esa:GetCertificateQuota', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], + '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"}]', ], - 'GetCnameFlattening' => [ - 'summary' => 'Queries the CNAME flattening configuration of a website', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetClientCaCertificate' => [ + 'summary' => 'Retrieves a specified client CA certificate.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '257388', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeCode' => '238932', + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The certificate ID. You can call the [ListClientCaCertificates](~~2860651~~) operation to obtain the certificate ID.', 'type' => 'string', 'required' => true, 'example' => 'babab9db65ee5efcca9f3d41d4b5****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', - ], - 'FlattenMode' => [ - 'description' => 'The CNAME flattening mode. Valid values:'."\n" - ."\n" - .'* flatten_all: flattens all CNAMEs.'."\n" - .'* flatten_all (default): flattens only the root domain.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'flatten_at_root' => 'flatten_at_root', - 'flatten_all' => 'flatten_all', + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'Status' => ['description' => 'The certificate status.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Certificate' => ['description' => 'The certificate content.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----', 'title' => ''], + 'Result' => [ + 'description' => 'The certificate information.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The certificate ID.', 'type' => 'string', 'example' => 'babab9db65ee5efcca9f3d41d4b5****', 'title' => ''], + 'Name' => ['description' => 'The certificate name.', 'type' => 'string', 'example' => 'yourCertName', 'title' => ''], + 'Status' => ['description' => 'The certificate status.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Type' => ['description' => 'The certificate type.', 'type' => 'string', 'example' => 'upload', 'title' => ''], + 'CommonName' => ['description' => 'The common name of the certificate.', 'type' => 'string', 'example' => 'www.example.com ', 'title' => ''], + 'NotBefore' => ['description' => 'The start time of the certificate validity period. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2023-03-31 02:08:00', 'title' => ''], + 'NotAfter' => ['description' => 'The end time of the certificate validity period. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-03-31 02:08:00', 'title' => ''], + 'Issuer' => ['description' => 'The certificate issuer.', 'type' => 'string', 'example' => 'GlobalSign nv-sa', 'title' => ''], + 'SAN' => ['description' => 'The Subject Alternative Name (SAN) of the certificate.', 'type' => 'string', 'example' => 'www.example.com,*.example.com', 'title' => ''], + 'SignatureAlgorithm' => ['description' => 'The signature algorithm of the certificate.', 'type' => 'string', 'example' => 'SHA256-RSA', 'title' => ''], + 'PubkeyAlgorithm' => ['description' => 'The public key algorithm of the certificate.', 'type' => 'string', 'example' => 'RSA', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-03-05 18:24:04', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-03-05 18:24:04', 'title' => ''], + 'SerialNumber' => ['description' => 'The certificate serial number.', 'type' => 'string', 'example' => 'babaded901474b9693acf530e0fb1d**', 'title' => ''], + 'FingerprintSha256' => ['description' => 'The SHA-256 fingerprint of the certificate.', 'type' => 'string', 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', 'title' => ''], ], - 'example' => 'flatten_all', 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', 'title' => ''], ], 'example' => '', ], @@ -37636,301 +21073,188 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'Id.MissingParameter', 'errorMessage' => 'The parameter Id is required.', 'description' => 'The required parameter Id is missing.'], + ], + 403 => [ + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], + ], + [ + ['errorCode' => 'Certificate.NotFound', 'errorMessage' => 'The specified certificate does not exist.', 'description' => 'The specified certificate does not exist.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + '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\\": \\"babaded901474b9693acf530e0fb1d**\\",\\n \\"FingerprintSha256\\": \\"1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****\\"\\n },\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', + 'title' => 'Get a client CA certificate', + 'changeSet' => [ + ['createdAt' => '2025-03-12T03:30:13.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F61CDR30-E83C-4FDA-BF73-9A94CDD44229\\",\\n \\"FlattenMode\\": \\"flatten_all\\"\\n}","type":"json"}]', - 'title' => 'GetCnameFlattening', - 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetCnameFlattening', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetClientCaCertificate'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ - 'action' => 'esa:GetCnameFlattening', + 'action' => 'esa:GetClientCaCertificate', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'operationType' => 'read', ], - 'GetCompressionRule' => [ - 'summary' => 'Query Compression Rule Details', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetClientCaCertificateHostnames' => [ + 'summary' => 'Retrieves the list of hostnames bound to a specified client CA certificate. If no certificate is specified, this operation returns the list of hostnames bound to the ESA CA certificate.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '257665', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeCode' => '239234', + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '34003500310****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. To obtain this ID, call the [ListSites](~~ListSites~~) API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ - 'name' => 'ConfigId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID, which can be obtained by calling the [ListCompressionRules](~~2867498~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The client CA certificate ID.', 'type' => 'string', 'required' => false, 'example' => 'babaded901474b9693acf530e0fb****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Request response result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '186C6DF2-D96A-5102-B04E-FB92C16C9867', - ], - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '35281609698****', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'Configuration type. Possible values:'."\n" - .'- global: Global configuration.'."\n" - .'- rule: Rule-based configuration.', - 'type' => 'string', - 'example' => 'rule', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'The version number of the site configuration. For sites with version management enabled, this parameter can specify the effective version of the configuration, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'Rule execution order. The smaller the value, the higher the priority.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Possible values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], - 'Gzip' => [ - 'description' => 'Gzip compression. Possible values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Brotli' => [ - 'description' => 'Brotli compression. Possible values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Zstd' => [ - 'description' => 'Zstd compression. Value range: '."\n" - .'- on: enabled. '."\n" - .'- off: disabled.', - 'type' => 'string', - 'example' => 'on', + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com ', 'title' => ''], + 'Id' => ['description' => 'The client CA certificate ID.', 'type' => 'string', 'example' => 'babaded901474b9693acf530e0fb****', 'title' => ''], + 'Hostnames' => [ + 'type' => 'array', + 'items' => ['description' => 'A domain name.', 'type' => 'string', 'example' => 'www.example.com ', 'title' => ''], + 'description' => 'A list of domain names.', 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3558df77-8a7a-4060-a900-2d7949403836', 'title' => ''], ], + 'title' => '', + 'description' => 'The response object.', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], ], - ], - '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"}]', - 'title' => 'Query Compression Rule Configuration Details', - 'changeSet' => [ - [ - 'createdAt' => '2025-02-12T02:25:41.000Z', - 'description' => 'Response parameters changed', + 403 => [ + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], ], - 'flowControl' => [ - 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetCompressionRule', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'ramActions' => [ - [ - 'operationType' => 'get', - 'ramAction' => [ - 'action' => 'esa:GetCompressionRule', - 'authLevel' => 'resource', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], - ], - ], - ], + 'title' => 'GetClientCaCertificateHostnames', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'operationType' => 'read', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 1234567890123,\\n \\"SiteName\\": \\"example.com \\",\\n \\"Id\\": \\"babaded901474b9693acf530e0fb****\\",\\n \\"Hostnames\\": [\\n \\"www.example.com \\"\\n ],\\n \\"RequestId\\": \\"3558df77-8a7a-4060-a900-2d7949403836\\"\\n}","type":"json"}]', ], - 'GetCrossBorderOptimization' => [ - 'summary' => 'Queries the configuration of Chinese mainland access optimization.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetClientCertificate' => [ + 'summary' => 'Retrieves information about a specified client certificate.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '257426', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeCode' => '238926', + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '340035003106221', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The certificate ID.', 'type' => 'string', 'required' => true, 'example' => 'baba39055622c008b90285a8838ed09a', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CF521A24-633F-5350-A6A5-42AD503D0D20', - ], - 'Enable' => [ - 'description' => 'Whether to enable Chinese mainland network access optimization. By default, it is disabled. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com'."\n", 'title' => ''], + 'Status' => ['description' => 'The certificate status.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'Certificate' => ['description' => 'The certificate content.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----', 'title' => ''], + 'Result' => [ + 'description' => 'The certificate information.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The certificate ID.', 'type' => 'string', 'example' => 'baba39055622c008b90285a8838ed09a', 'title' => ''], + 'Name' => ['description' => 'The certificate name.', 'type' => 'string', 'example' => 'yourCertName', 'title' => ''], + 'Status' => ['description' => 'The certificate status.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'Type' => ['description' => 'The certificate type.', 'type' => 'string', 'example' => 'dcdn', 'title' => ''], + 'CommonName' => ['description' => 'The common name of the certificate.', 'type' => 'string', 'example' => 'www.example.com ', 'title' => ''], + 'NotBefore' => ['description' => 'The start time of the certificate validity period. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2023-03-31 02:08:00', 'title' => ''], + 'NotAfter' => ['description' => 'The end time of the certificate validity period. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-03-31 02:08:00', 'title' => ''], + 'Issuer' => ['description' => 'The certification authority that issued the certificate.', 'type' => 'string', 'example' => 'GlobalSign nv-sa', 'title' => ''], + 'SAN' => ['description' => 'The Subject Alternative Name (SAN) of the certificate.', 'type' => 'string', 'example' => 'www.example.com,*.example.com', 'title' => ''], + 'SignatureAlgorithm' => ['description' => 'The signature algorithm of the certificate.', 'type' => 'string', 'example' => 'SHA256-RSA', 'title' => ''], + 'PubkeyAlgorithm' => ['description' => 'The public key algorithm of the certificate.', 'type' => 'string', 'example' => 'RSA', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-06-24 07:48:51', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-09-22 05:33:13', 'title' => ''], + 'CACertificateId' => ['description' => 'The CA certificate ID.', 'type' => 'string', 'example' => 'babab9db65ee5efcca9f3d41d4b50d66', 'title' => ''], + 'SerialNumber' => ['description' => 'The certificate serial number.', 'type' => 'string', 'example' => 'babaded901474b9693acf530e0fb1d**', 'title' => ''], + 'FingerprintSha256' => ['description' => 'The SHA-256 fingerprint of the certificate.', 'type' => 'string', 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', 'title' => ''], ], - 'example' => 'on', 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', 'title' => ''], ], 'example' => '', ], @@ -37938,586 +21262,216 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Id.MissingParameter', 'errorMessage' => 'The parameter Id is required.', 'description' => 'The required parameter Id is missing.'], + ], + 403 => [ + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], + ], + [ + ['errorCode' => 'Certificate.NotFound', 'errorMessage' => 'The specified certificate does not exist.', 'description' => 'The specified certificate does not exist.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get client certificate information', + 'changeSet' => [ + ['createdAt' => '2025-03-12T03:30:14.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CF521A24-633F-5350-A6A5-42AD503D0D20\\",\\n \\"Enable\\": \\"on\\"\\n}","type":"json"}]', - 'title' => 'GetCrossBorderOptimization', - 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetCrossBorderOptimization', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetClientCertificate'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ - 'action' => 'esa:GetCrossBorderOptimization', + 'action' => 'esa:GetClientCertificate', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'operationType' => 'read', + '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\\": \\"babaded901474b9693acf530e0fb1d**\\",\\n \\"FingerprintSha256\\": \\"1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****\\"\\n },\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'GetCustomHostname' => [ - 'summary' => 'Retrieves the detailed configuration of a specific Software as a Service (SaaS) domain name. The configuration includes the TXT record name and value for domain name validation, and the certificate expiration time when SSL is enabled.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetClientCertificateHostnames' => [ + 'summary' => 'Retrieves the list of hostnames bound to a specified client CA certificate. If you do not specify a certificate, the operation returns the list of hostnames for the ESA CA certificate.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '239656', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4DMKZ4', - ], + 'abilityTreeCode' => '239234', + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ - 'name' => 'HostnameId', + 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the SaaS domain name. You can obtain this ID by calling the [ListCustomHostnames](~~3018667~~) operation.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'title' => '', - 'example' => '1234567890123', - ], + 'schema' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The certificate ID.', 'type' => 'string', 'required' => false, 'example' => 'baba39055622c008b90285a8838ed09a', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID generated by Alibaba Cloud for the request.', - 'type' => 'string', - 'title' => '', - 'example' => '7C414690-9D7B-5D66-9CD9-AD0B3F25ED49', - ], - 'CustomHostnameModel' => [ - 'type' => 'object', - 'properties' => [ - 'HostnameId' => [ - 'description' => 'The ID of the SaaS domain name.', - 'type' => 'integer', - 'format' => 'int64', - 'title' => '', - 'example' => '1234567890123', - ], - 'Hostname' => [ - 'description' => 'The SaaS domain name.', - 'type' => 'string', - 'title' => '', - 'example' => 'custom.site.com', - ], - 'SiteId' => [ - 'description' => 'The site ID.', - 'type' => 'integer', - 'format' => 'int64', - 'title' => '', - 'example' => '890601022130656', - ], - 'SiteName' => [ - 'description' => 'The site name.', - 'type' => 'string', - 'title' => '', - 'example' => 'example.com', - ], - 'RecordId' => [ - 'description' => 'The record ID.', - 'type' => 'integer', - 'format' => 'int64', - 'title' => '', - 'example' => '4042843419650112', - ], - 'RecordName' => [ - 'description' => 'The record name.', - 'type' => 'string', - 'title' => '', - 'example' => 'origin.example.com', - ], - 'Status' => [ - 'description' => 'The status of the SaaS domain name.'."\n" - ."\n" - .'- **pending**: Pending validation.'."\n" - ."\n" - .'- **active**: Active.'."\n" - ."\n" - .'- **conflicted**: In use.'."\n" - ."\n" - .'- **offline**: Offline.', - 'type' => 'string', - 'enum' => [ - 'pending', - 'active', - 'conflicted', - 'offline', - ], - 'title' => '', - 'example' => 'active', - ], - 'VerifyHost' => [ - 'description' => 'The TXT record name for domain validation.', - 'type' => 'string', - 'title' => '', - 'example' => '_esa_custom_hostname.custom.site.com', - ], - 'VerifyCode' => [ - 'description' => 'The TXT record value for domain validation.', - 'type' => 'string', - 'title' => '', - 'example' => 'verify_16ab7f4d389d4dff6655f995c6a997bd', - ], - 'SslFlag' => [ - 'description' => 'The SSL switch.'."\n" - ."\n" - .'- **on**: Enabled.'."\n" - ."\n" - .'- **off**: Disabled.', - 'type' => 'string', - 'enum' => [ - 'on', - 'off', - ], - 'title' => '', - 'example' => 'on', - ], - 'CertType' => [ - 'description' => 'The certificate type.'."\n" - ."\n" - .'- **free**: Free certificate.'."\n" - ."\n" - .'- **upload**: Uploaded certificate.'."\n" - ."\n" - .'- **cas**: Alibaba Cloud Security certificate.', - 'type' => 'string', - 'enum' => [ - 'free', - 'upload', - 'cas', - ], - 'title' => '', - 'example' => 'free', - ], - 'CasId' => [ - 'description' => 'The ID of the Alibaba Cloud Security certificate.', - 'type' => 'integer', - 'format' => 'int64', - 'title' => '', - 'example' => '30000478', - ], - 'CertId' => [ - 'description' => 'The certificate ID.', - 'type' => 'string', - 'title' => '', - 'example' => 'baba2c9e90e840b3b55698cedf02b308', - ], - 'Certificate' => [ - 'description' => 'The content of the certificate.', - 'type' => 'string', - 'title' => '', - 'example' => '-----BEGIN CERTIFICATE-----', - ], - 'CertStatus' => [ - 'description' => 'The status of the certificate.'."\n" - ."\n" - .'- **OK**: Normal.'."\n" - ."\n" - .'- **Applying**: The request is being processed.'."\n" - ."\n" - .'- **ApplyFailed**: The request failed.'."\n" - ."\n" - .'- **Expiring**: The certificate is about to expire.'."\n" - ."\n" - .'- **Expired**: The certificate has expired.', - 'type' => 'string', - 'enum' => [ - 'OK', - 'Expired', - 'Expiring', - 'Applying', - 'ApplyFailed', - ], - 'title' => '', - 'example' => 'OK', - ], - 'CertTxtKey' => [ - 'description' => 'The TXT record name for certificate validation.', - 'type' => 'string', - 'title' => '', - 'example' => '_acme-challenge.custom.site.com', - ], - 'CertTxtValue' => [ - 'description' => 'The TXT record value for certificate validation.', - 'type' => 'string', - 'title' => '', - 'example' => 'lcKYad3UQXgrZLvMm_6TBUYKK4xTkGmninV0Mzx4gjM', - ], - 'CertHttpKey' => [ - 'description' => 'The HTTP URL for certificate validation.', - 'type' => 'string', - 'title' => '', - 'example' => 'http://custom.site.com/.well-known/acme-challenge/jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc', - ], - 'CertHttpValue' => [ - 'description' => 'The HTTP content for certificate validation.', - 'type' => 'string', - 'title' => '', - 'example' => 'jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc.GridYdfJJB5PgFEL-t89XfaFvMPB4f2-I9fwLpKl6e0', - ], - 'CertNotAfter' => [ - 'description' => 'The expiration time of the certificate. The date is in the ISO 8601 format and is in UTC. The format is \\`yyyy-MM-ddTHH:mm:ssZ\\`.', - 'type' => 'string', - 'title' => '', - 'example' => '2026-04-19T11:15:20Z', - ], - 'CertApplyMessage' => [ - 'description' => 'The error description for the free certificate request.', - 'type' => 'string', - 'title' => '', - 'example' => 'canceled', - ], - 'CertApplyCode' => [ - 'description' => 'The error code for the free certificate request.', - 'type' => 'integer', - 'format' => 'int64', - 'title' => '', - 'example' => '2', - ], - 'CreateTime' => [ - 'description' => 'The time when the SaaS domain name was created. The date is in the ISO 8601 format and is in UTC. The format is \\`yyyy-MM-ddTHH:mm:ssZ\\`.', - 'type' => 'string', - 'title' => '', - 'example' => '2026-04-19T11:15:20Z', - ], - 'UpdateTime' => [ - 'description' => 'The time when the SaaS domain name was last updated. The date is in the ISO 8601 format and is in UTC. The format is \\`yyyy-MM-ddTHH:mm:ssZ\\`.', - 'type' => 'string', - 'title' => '', - 'example' => '2026-04-19T11:15:20Z', - ], - 'OfflineReason' => [ - 'description' => 'The reason why the SaaS domain name is offline.'."\n" - ."\n" - .'- **expiration\\_arrears**: The subscription expired or the account has an overdue payment.'."\n" - ."\n" - .'- **internally\\_disabled**: Disabled by the system.'."\n" - ."\n" - .'- **missing\\_icp**: The domain name is missing an ICP filing.'."\n" - ."\n" - .'- **content\\_violation**: Content violation.'."\n" - ."\n" - .'- **proactively\\_disabled**: The domain name was disabled manually or because it reached the usage cap.', - 'type' => 'string', - 'enum' => [ - 'proactively_disabled', - 'content_violation', - 'internally_disabled', - 'missing_icp', - 'expiration_arrears', - ], - 'title' => '', - 'example' => 'missing_icp', - ], - 'ConflictWith' => [ - 'description' => 'The reason why the SaaS domain name is in use.'."\n" - ."\n" - .'- **existing\\_custom\\_hostname**: Conflicts with an existing SaaS domain name.'."\n" - ."\n" - .'- **existing\\_record**: Conflicts with an existing site record.'."\n" - ."\n" - .'- **existing\\_load\\_balancer**: Conflicts with an existing load balancer.'."\n" - ."\n" - .'- **existing\\_origin\\_pool**: Conflicts with an existing origin pool.', - 'type' => 'string', - 'enum' => [ - 'existing_custom_hostname', - 'existing_site', - 'existing_record', - 'existing_load_balancer', - 'existing_origin_pool', - ], - 'title' => '', - 'example' => 'existing_custom_hostname', - ], - 'PrivateKey' => [ - 'description' => 'The private key of the certificate.', - 'type' => 'string', - 'example' => '-----BEGIN RSA PRIVATE KEY-----', - 'title' => '', - ], - ], - 'description' => 'The information about the SaaS domain name.', + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com'."\n", 'title' => ''], + 'Id' => ['description' => 'The client CA certificate ID.', 'type' => 'string', 'example' => 'baba39055622c008b90285a8838ed09a', 'title' => ''], + 'Hostnames' => [ + 'description' => 'The list of bound hostnames.', + 'type' => 'array', + 'items' => ['description' => 'The hostname.', 'type' => 'string', 'example' => 'www.example.com ', 'title' => ''], 'title' => '', 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n", 'title' => ''], ], - 'description' => '', - 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], ], - 404 => [ - [ - 'errorCode' => 'CustomHostname.NotFound', - 'errorMessage' => 'The custom hostname does not exist. Modify it and try again.', - 'description' => 'The custom hostname does not exist. Modify it and try again.', - ], - [ - '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' => '', - ], + 403 => [ + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'title' => 'GetCustomHostname', + '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"}]', + 'title' => 'GetClientCertificateHostnames', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetClientCertificateHostnames'], + ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ - 'action' => 'esa:GetCustomHostname', - 'authLevel' => 'operate', + 'action' => 'esa:GetClientCertificateHostnames', + 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - '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' => 'Retrieve details about a site\'s custom response code configuration.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetCnameFlattening' => [ + 'summary' => 'Queries the CNAME flattening configuration of a website', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '257648', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeCode' => '257388', + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID. For more information, see [ListSites](~~2850189~~).', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '775724064754208', - 'title' => '', - ], - ], - [ - 'name' => 'ConfigId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '424022244554752', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'title' => '', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '352816096987136', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'The configuration type. Valid values:'."\n" - ."\n" - .'- global: Global configuration.'."\n" - ."\n" - .'- rule: Rule configuration.', - 'type' => 'string', - 'example' => 'global', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'The version number of the site configuration. For sites with version control enabled, use this parameter to specify the site version where the configuration takes effect. The default is version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'The rule execution order. A smaller value indicates higher execution priority.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'The rule switch. Do not set this parameter when adding a global configuration. Valid values:'."\n" - ."\n" - .'- on: Enable.'."\n" - ."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'The rule content. Use conditional expressions to match user requests. Do not set this parameter when adding a global configuration. There are two scenarios:'."\n" - ."\n" - .'- Match all incoming requests: Set the value to true.'."\n" + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229'], + 'FlattenMode' => [ + 'description' => 'The CNAME flattening mode. Valid values:'."\n" ."\n" - .'- Match specific requests: Set the value to a custom expression, such as (http.host eq "video.example.com").', - 'type' => 'string', - 'example' => '(http.host eq "video.example.com")'."\n", - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'The rule name. Do not set this parameter when adding a global configuration.', - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], - 'ReturnCode' => [ - 'description' => 'The response code.', - 'type' => 'string', - 'example' => '200', - 'title' => '', - ], - 'PageId' => [ - 'description' => 'The response page.', + .'* flatten_all: flattens all CNAMEs.'."\n" + .'* flatten_all (default): flattens only the root domain.'."\n", 'type' => 'string', - 'example' => '0', + 'enumValueTitles' => ['flatten_at_root' => 'flatten_at_root', 'flatten_all' => 'flatten_all'], + 'example' => 'flatten_all', 'title' => '', ], ], - 'title' => '', - 'description' => 'The request response result.', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'title' => 'GetCustomResponseCodeRule', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F61CDR30-E83C-4FDA-BF73-9A94CDD44229\\",\\n \\"FlattenMode\\": \\"flatten_all\\"\\n}","type":"json"}]', + 'title' => 'GetCnameFlattening', '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' => [ - 'summary' => 'Query Site Developer Mode Configuration', - 'methods' => [ - 'get', + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCnameFlattening'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetCnameFlattening', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], + ], + ], ], + 'operationType' => 'read', + ], + 'GetCompressionRule' => [ + 'summary' => 'Query Compression Rule Details', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -38528,25 +21482,110 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '257406', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeCode' => '257665', + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', + 'schema' => ['description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '34003500310****', 'title' => ''], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => ['description' => 'Configuration ID, which can be obtained by calling the [ListCompressionRules](~~2867498~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '35281609698****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '5407498413****', - 'title' => '', + 'title' => 'Schema of Response', + 'description' => 'Request response result.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '186C6DF2-D96A-5102-B04E-FB92C16C9867'], + 'ConfigId' => ['description' => 'Configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '35281609698****', 'title' => ''], + 'ConfigType' => ['description' => 'Configuration type. Possible values:'."\n" + .'- global: Global configuration.'."\n" + .'- rule: Rule-based configuration.', 'type' => 'string', 'example' => 'rule', 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the site configuration. For sites with version management enabled, this parameter can specify the effective version of the configuration, defaulting to version 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Sequence' => ['description' => 'Rule execution order. The smaller the value, the higher the priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuleEnable' => ['description' => 'Rule switch. This parameter is not required when adding a global configuration. Possible values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" + .'- Match all incoming requests: Set the value to true'."\n" + .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', 'type' => 'string', 'example' => '(http.host eq "video.example.com")', 'title' => ''], + 'RuleName' => ['description' => 'Rule name. This parameter is not required when adding a global configuration.', 'type' => 'string', 'example' => 'rule_example', 'title' => ''], + 'Gzip' => ['description' => 'Gzip compression. Possible values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Brotli' => ['description' => 'Brotli compression. Possible values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Zstd' => ['description' => 'Zstd compression. Value range: '."\n" + .'- on: enabled. '."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ], + ], + '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"}]', + 'title' => 'Query Compression Rule Configuration Details', + 'changeSet' => [ + ['createdAt' => '2025-02-12T02:25:41.000Z', 'description' => 'Response parameters changed'], + ], + '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}'], + ], ], ], ], + 'operationType' => 'read', + ], + 'GetCrossBorderOptimization' => [ + 'summary' => 'Queries the configuration of Chinese mainland access optimization.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257426', + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '340035003106221', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -38554,22 +21593,14 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CF521A24-633F-5350-A6A5-42AD503D0D20'], 'Enable' => [ - 'description' => 'Switch. Values:'."\n" + 'description' => 'Whether to enable Chinese mainland network access optimization. By default, it is disabled. Valid values:'."\n" ."\n" - .'- **on**: Enabled.'."\n" - .'- **off**: Disabled.', + .'* on'."\n" + .'* off'."\n", 'type' => 'string', - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], + 'enumValueTitles' => ['off' => 'off', 'on' => 'on'], 'example' => 'on', 'title' => '', ], @@ -38580,87 +21611,56 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"156A6B-677B1A-4297B7-9187B7-2B44792\\",\\n \\"Enable\\": \\"on\\"\\n}","type":"json"}]', - 'title' => 'GetDevelopmentMode', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CF521A24-633F-5350-A6A5-42AD503D0D20\\",\\n \\"Enable\\": \\"on\\"\\n}","type":"json"}]', + 'title' => 'GetCrossBorderOptimization', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetDevelopmentMode', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCrossBorderOptimization'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ - 'action' => 'esa:GetDevelopmentMode', + 'action' => 'esa:GetCrossBorderOptimization', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], 'operationType' => 'read', ], - 'GetEdgeContainerApp' => [ - 'summary' => 'Queries the information about a containerized application, including basic application configurations and health check configurations.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetCustomHostname' => [ + 'summary' => 'Retrieves the detailed configuration of a single SaaS domain name, including the domain verification TXT name, domain verification TXT content, and certificate expiration time (when SSL is enabled).', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '239322', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeCode' => '239656', + 'abilityTreeNodes' => ['FEATUREdcdn4DMKZ4'], ], 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'HostnameId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'app-88068867578379****', - 'maxLength' => 64, - 'minLength' => 20, - 'title' => '', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the SaaS domain name. You can obtain this value by calling the [ListCustomHostnames](~~3018667~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123'], ], ], 'responses' => [ @@ -38668,174 +21668,105 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792', - 'title' => '', - ], - 'App' => [ - 'description' => 'The basic information about the application.'."\n", + 'RequestId' => ['title' => '', 'description' => 'The request ID, which is a unique identifier generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => '7C414690-9D7B-5D66-9CD9-AD0B3F25ED49'], + 'CustomHostnameModel' => [ + 'description' => 'The information about the queried SaaS domain name.', 'type' => 'object', 'properties' => [ + 'HostnameId' => ['title' => '', 'description' => 'The ID of the SaaS domain name.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123'], + 'Hostname' => ['title' => '', 'description' => 'The SaaS domain name.', 'type' => 'string', 'example' => 'custom.site.com'], + 'SiteId' => ['title' => '', 'description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '890601022130656'], + 'SiteName' => ['title' => '', 'description' => 'The site name.', 'type' => 'string', 'example' => 'example.com'], + 'RecordId' => ['title' => '', 'description' => 'The record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '4042843419650112'], + 'RecordName' => ['title' => '', 'description' => 'The record name.', 'type' => 'string', 'example' => 'origin.example.com'], 'Status' => [ - 'description' => 'The status of the application. Valid values:'."\n" - ."\n" - .'* creating: The application is being created.'."\n" - .'* failed: The application failed to be created.'."\n" - .'* created: The application is created.'."\n", - 'type' => 'string', - 'example' => 'created', - 'title' => '', - ], - 'GatewayType' => [ - 'description' => 'The type of the gateway. Valid values:'."\n" - ."\n" - .'* l7: Layer 7 gateway.'."\n" - .'* l4: Layer 4 gateway.'."\n", - 'type' => 'string', - 'example' => 'l7', 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the application was created.'."\n", + 'description' => 'The status of the SaaS domain name. Valid values:'."\n" + .'- **pending**: Pending verification.'."\n" + .'- **active**: Activated.'."\n" + .'- **conflicted**: Occupied.'."\n" + .'- **offline**: Offline.'."\n" + .'- **configuring**: Being configured.', + 'enumValueTitles' => ['conflicted' => 'Occupied.', 'offline' => 'Offline.', 'configuring' => 'Being configured.', 'pending' => 'Pending verification.', 'active' => 'Activated.'], 'type' => 'string', - 'example' => '2023-07-25T05:58:05Z', - 'title' => '', - ], - 'VersionCount' => [ - 'description' => 'The number of versions of the application.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', + 'enum' => ['pending', 'active', 'conflicted', 'offline', 'configuring'], + 'example' => 'active', ], - 'DomainName' => [ - 'description' => 'The domain name that is associated with the application. If no domain name is associated with the application, the value is an empty string.'."\n", - 'type' => 'string', - 'example' => 'www.1feel.cn', + 'VerifyHost' => ['title' => '', 'description' => 'The TXT name for domain verification.', 'type' => 'string', 'example' => '_esa_custom_hostname.custom.site.com'], + 'VerifyCode' => ['title' => '', 'description' => 'The TXT content for domain verification.', 'type' => 'string', 'example' => 'verify_16ab7f4d389d4dff6655f995c6a997bd'], + 'SslFlag' => [ 'title' => '', - ], - 'Remarks' => [ - 'description' => 'The remarks about the application.'."\n", + 'description' => 'The SSL switch. Valid values:'."\n" + .'- **on**: SSL is enabled.'."\n" + .'- **off**: SSL is disabled.', + 'enumValueTitles' => ['off' => 'SSL is disabled.', 'on' => 'SSL is enabled.'], 'type' => 'string', - 'example' => 'test app', - 'title' => '', + 'enum' => ['on', 'off'], + 'example' => 'on', ], - 'ServicePort' => [ - 'description' => 'The server port. Valid values: 1 to 65535.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', + 'CertType' => [ 'title' => '', - ], - 'AppId' => [ - 'description' => 'The application ID.'."\n", + 'description' => 'The certificate type. Valid values:'."\n" + .'- **free**: Free certificate.'."\n" + .'- **upload**: Uploaded certificate.'."\n" + .'- **cas**: SSL Certificates Service certificate.', + 'enumValueTitles' => ['cas' => 'SSL Certificates Service certificate.', 'upload' => 'Uploaded certificate.', 'free' => 'Free certificate.'], 'type' => 'string', - 'example' => 'app-88068867578379****', - 'title' => '', + 'enum' => ['free', 'upload', 'cas'], + 'example' => 'free', ], - 'TargetPort' => [ - 'description' => 'The backend port, which is also the service port of the application. Valid values: 1 to 65535.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', + 'CasId' => ['title' => '', 'description' => 'The SSL Certificates Service certificate ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '30000478'], + 'CertId' => ['title' => '', 'description' => 'The certificate ID.', 'type' => 'string', 'example' => 'baba2c9e90e840b3b55698cedf02b308'], + 'Certificate' => ['title' => '', 'description' => 'The certificate content.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----'], + 'CertStatus' => [ 'title' => '', - ], - 'QuicCid' => [ - 'description' => 'Indicates whether QUIC is enabled.'."\n", + 'description' => 'The certificate status. Valid values:'."\n" + .'- **OK**: Normal.'."\n" + .'- **Applying**: Being applied.'."\n" + .'- **ApplyFailed**: Application failed.'."\n" + .'- **Expiring**: About to expire.'."\n" + .'- **Expired**: Expired.', + 'enumValueTitles' => ['Expiring' => 'About to expire.', 'ApplyFailed' => 'Application failed.', 'Expired' => 'Expired.', 'Applying' => 'Being applied.', 'OK' => 'Normal.'], 'type' => 'string', - 'example' => 'false', - 'title' => '', + 'enum' => ['OK', 'Expired', 'Expiring', 'Applying', 'ApplyFailed'], + 'example' => 'OK', ], - 'Name' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'example' => 'test-app1', + 'CertTxtKey' => ['title' => '', 'description' => 'The TXT name for certificate verification.', 'type' => 'string', 'example' => '_acme-challenge.custom.site.com'], + 'CertTxtValue' => ['title' => '', 'description' => 'The TXT content for certificate verification.', 'type' => 'string', 'example' => 'lcKYad3UQXgrZLvMm_6TBUYKK4xTkGmninV0Mzx4gjM'], + 'CertHttpKey' => ['title' => '', 'description' => 'The HTTP address for certificate verification.', 'type' => 'string', 'example' => 'http://custom.site.com/.well-known/acme-challenge/jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc'], + 'CertHttpValue' => ['title' => '', 'description' => 'The HTTP content for certificate verification.', 'type' => 'string', 'example' => 'jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc.GridYdfJJB5PgFEL-t89XfaFvMPB4f2-I9fwLpKl6e0'], + 'CertNotAfter' => ['title' => '', 'description' => 'The certificate expiration time, in ISO 8601 format with UTC time. The format is yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2026-04-19T11:15:20Z'], + 'CertApplyMessage' => ['title' => '', 'description' => 'The error message for the free certificate application.', 'type' => 'string', 'example' => 'canceled'], + 'CertApplyCode' => ['title' => '', 'description' => 'The error code for the free certificate application.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'CreateTime' => ['title' => '', 'description' => 'The time when the SaaS domain name was created, in ISO 8601 format with UTC time. The format is yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2026-04-19T11:15:20Z'], + 'UpdateTime' => ['title' => '', 'description' => 'The time when the SaaS domain name was last updated, in ISO 8601 format with UTC time. The format is yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2026-04-19T11:15:20Z'], + 'OfflineReason' => [ 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'The time when the application was last modified. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", + 'description' => 'The reason why the SaaS domain name was taken offline. Valid values:'."\n" + .'- **expiration_arrears**: The subscription plan expired or the account has an overdue payment.'."\n" + .'- **internally_disabled**: Disabled by the system.'."\n" + .'- **missing_icp**: The domain name does not have an ICP filing.'."\n" + .'- **content_violation**: Content violation.'."\n" + .'- **proactively_disabled**: You proactively disabled the domain name or the usage cap you configured was reached.', + 'enumValueTitles' => ['expiration_arrears' => 'The subscription plan expired or the account has an overdue payment.', 'proactively_disabled' => 'Proactively disabled or usage cap reached.', 'content_violation' => 'Content violation.', 'internally_disabled' => 'Disabled by the system.', 'missing_icp' => 'The domain name does not have an ICP filing.'], 'type' => 'string', - 'example' => '2023-03-26T02:35:58Z', - 'title' => '', + 'enum' => ['proactively_disabled', 'content_violation', 'internally_disabled', 'missing_icp', 'expiration_arrears'], + 'example' => 'missing_icp', ], - 'HealthCheck' => [ - 'description' => 'The information about health checks.'."\n", - 'type' => 'object', - 'properties' => [ - 'Timeout' => [ - 'description' => 'The timeout period of the health check. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The health check type. Valid values:'."\n" - ."\n" - .'* l7'."\n" - .'* l4'."\n", - 'type' => 'string', - 'example' => 'l7', - 'title' => '', - ], - 'Host' => [ - 'description' => 'The domain name that is used for health checks.'."\n", - 'type' => 'string', - 'example' => 'test.com', - 'title' => '', - ], - 'Interval' => [ - 'description' => 'The interval between health checks. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'title' => '', - ], - 'SuccTimes' => [ - 'description' => 'The number of consecutive successful health checks required for an application to be considered as healthy.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'title' => '', - ], - 'Method' => [ - 'description' => 'The HTTP method that the health check request uses.'."\n", - 'type' => 'string', - 'example' => 'HEAD', - 'title' => '', - ], - 'HttpCode' => [ - 'description' => 'The range of health check status codes that indicate successful health checks.'."\n", - 'type' => 'string', - 'example' => 'http_2xx', - 'title' => '', - ], - 'FailTimes' => [ - 'description' => 'The number of consecutive failed health checks required for an application to be considered as unhealthy.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'title' => '', - ], - 'Port' => [ - 'description' => 'The health check port.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - 'title' => '', - ], - 'Uri' => [ - 'description' => 'The health check URL.'."\n", - 'type' => 'string', - 'example' => '/health_check', - 'title' => '', - ], - ], + 'ConflictWith' => [ 'title' => '', - 'example' => '', + 'description' => 'The reason why the SaaS domain name is occupied. Valid values:'."\n" + .'- **existing_custom_hostname**: Conflicts with an existing SaaS domain name.'."\n" + .'- **existing_record**: Conflicts with an existing site record.'."\n" + .'- **existing_load_balancer**: Conflicts with an existing load balancing instance.'."\n" + .'- **existing_origin_pool**: Conflicts with an existing origin IPAM pool.'."\n" + .'- **existing_site**: Conflicts with an existing site.', + 'enumValueTitles' => ['existing_load_balancer' => 'Conflicts with an existing load balancing instance.', 'existing_custom_hostname' => 'Conflicts with an existing SaaS domain name.', 'existing_site' => 'Conflicts with an existing site.', 'existing_record' => 'Conflicts with an existing site record.', 'existing_origin_pool' => 'Conflicts with an existing origin pool.'], + 'type' => 'string', + 'enum' => ['existing_custom_hostname', 'existing_site', 'existing_record', 'existing_load_balancer', 'existing_origin_pool'], + 'example' => 'existing_custom_hostname', ], + 'PrivateKey' => ['description' => 'The private key of the certificate.', 'type' => 'string', 'example' => '-----BEGIN RSA PRIVATE KEY-----', 'title' => ''], ], 'title' => '', 'example' => '', @@ -38849,76 +21780,45 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], ], 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'CustomHostname.NotFound', 'errorMessage' => 'The custom hostname does not exist. Modify it and try again.', 'description' => 'The custom hostname does not exist. Modify it and try again.'], + ['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' => [], ], - '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"}]', - 'title' => 'GetEdgeContainerApp', + 'title' => 'Query saaS domain name details', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetEdgeContainerApp', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomHostname'], ], ], 'ramActions' => [ [ - 'operationType' => 'none', + 'operationType' => 'get', 'ramAction' => [ - 'action' => 'esa:GetEdgeContainerApp', + 'action' => 'esa:GetCustomHostname', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], + '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"}]', ], - 'GetEdgeContainerAppLogRiver' => [ - 'summary' => 'Queries the log collection configuration of a containerized application.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetCustomResponseCodeRule' => [ + 'summary' => 'Retrieve details about a site\'s custom response code configuration.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -38930,127 +21830,416 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '249444', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeCode' => '257648', + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'app-880688675****88', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID. For more information, see [ListSites](~~2850189~~).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '775724064754208', 'title' => ''], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => ['description' => 'Configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '424022244554752', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - ], - 'Stdout' => [ - 'description' => 'Indicates whether the standard output of the container is collected.'."\n", - 'type' => 'boolean', - 'title' => '', - 'example' => '', - ], - 'Path' => [ - 'description' => 'The log path of the container. It must be an absolute path that starts with a forward slash (/). You can use asterisks (\\*) and question marks (?) as wildcards.'."\n", - 'type' => 'string', - 'example' => '/root/hello.log', - 'title' => '', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'title' => '', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], + 'ConfigId' => ['description' => 'Configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '352816096987136', 'title' => ''], + 'ConfigType' => ['description' => 'The configuration type. Valid values:'."\n" + ."\n" + .'- global: Global configuration.'."\n" + ."\n" + .'- rule: Rule configuration.', 'type' => 'string', 'example' => 'global', 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the site configuration. For sites with version control enabled, use this parameter to specify the site version where the configuration takes effect. The default is version 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Sequence' => ['description' => 'The rule execution order. A smaller value indicates higher execution priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuleEnable' => ['description' => 'The rule switch. Do not set this parameter when adding a global configuration. Valid values:'."\n" + ."\n" + .'- on: Enable.'."\n" + ."\n" + .'- off: Disable.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'The rule content. Use conditional expressions to match user requests. Do not set this parameter when adding a global configuration. There are two scenarios:'."\n" + ."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + ."\n" + .'- Match specific requests: Set the value to a custom expression, such as (http.host eq "video.example.com").', 'type' => 'string', 'example' => '(http.host eq "video.example.com")'."\n", 'title' => ''], + 'RuleName' => ['description' => 'The rule name. Do not set this parameter when adding a global configuration.', 'type' => 'string', 'example' => 'rule_example', 'title' => ''], + 'ReturnCode' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'PageId' => ['description' => 'The response page.', 'type' => 'string', 'example' => '0', 'title' => ''], ], + 'title' => '', + 'description' => 'The request response result.', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', - 'description' => 'Invalid parameter. Check the parameter configuration.', + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ], + ], + 'title' => 'GetCustomResponseCodeRule', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetCustomResponseCodeRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], - 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', + ], + '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"}]', + ], + 'GetDcvDelegation' => [ + 'summary' => 'Retrieves the delegated DCV information.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '265856', + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => ['description' => 'The site ID. You can obtain the site ID by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74'], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456****', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com ', 'title' => ''], + 'DelegationDomain' => ['description' => 'The DCV managed domain name.', 'type' => 'string', 'example' => '123456****.dcv.aliyun-esa.com', 'title' => ''], + ], + 'example' => '', ], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ], + 403 => [ + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], + ], + ], + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'Retrieve managed DCV information', + 'requestParamsDescription' => 'If no site exists, first call PurchaseRatePlan to obtain the InstanceId, and then call CreateSite to create a site.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"SiteId\\": 0,\\n \\"SiteName\\": \\"example.com \\",\\n \\"DelegationDomain\\": \\"123456****.dcv.aliyun-esa.com\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'GetDevelopmentMode' => [ + 'summary' => 'Query Site Developer Mode Configuration', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257406', + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => ['description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5407498413****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792'], + 'Enable' => [ + 'description' => 'Switch. Values:'."\n" + ."\n" + .'- **on**: Enabled.'."\n" + .'- **off**: Disabled.', + 'type' => 'string', + 'enumValueTitles' => ['off' => 'off', 'on' => 'on'], + 'example' => 'on', + 'title' => '', + ], + ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"Stdout\\": false,\\n \\"Path\\": \\"/root/hello.log\\"\\n}","type":"json"}]', - 'title' => 'GetEdgeContainerAppLogRiver', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"156A6B-677B1A-4297B7-9187B7-2B44792\\",\\n \\"Enable\\": \\"on\\"\\n}","type":"json"}]', + 'title' => 'GetDevelopmentMode', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetEdgeContainerAppLogRiver', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDevelopmentMode'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ - 'action' => 'esa:GetEdgeContainerAppLogRiver', - 'authLevel' => 'operate', + 'action' => 'esa:GetDevelopmentMode', + 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], + ], + ], + ], + 'operationType' => 'read', + ], + 'GetEdgeContainer' => [ + 'summary' => 'Retrieves the details of an edge container plan instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '261519', + 'abilityTreeNodes' => ['FEATUREdcdnGMYWU5'], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9BEB8659-9CDE-5F2C-83E9-50F55277E844'], + 'BillingMode' => [ + 'description' => 'The billing mode.', + 'enumValueTitles' => ['container_95' => 'monthly 95th percentile metering method.'], + 'type' => 'string', + 'example' => 'container_95', + 'title' => '', ], + 'Status' => [ + 'description' => 'The plan instance status.', + 'enumValueTitles' => ['Creating' => 'Being created.', 'Running' => 'Running.', 'NotOpened' => 'Not activated.'], + 'type' => 'string', + 'example' => 'Running', + 'title' => '', + ], + 'InstanceId' => ['description' => 'The plan instance ID.', 'type' => 'string', 'example' => 'esa-cn-jea67jfbs0x', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve edge container plan instance details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetEdgeContainer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9BEB8659-9CDE-5F2C-83E9-50F55277E844\\",\\n \\"BillingMode\\": \\"container_95\\",\\n \\"Status\\": \\"Running\\",\\n \\"InstanceId\\": \\"esa-cn-jea67jfbs0x\\"\\n}","type":"json"}]', ], - 'GetEdgeContainerAppResourceCapacity' => [ - 'summary' => 'Queries the resource capacity of a containerized application at the edge.', - 'path' => '', - 'methods' => [ - 'get', - 'post', + 'GetEdgeContainerApp' => [ + 'summary' => 'Queries the information about a containerized application, including basic application configurations and health check configurations.', + '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' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'app-88068867578379****', 'maxLength' => 64, 'minLength' => 20, 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792', 'title' => ''], + 'App' => [ + 'description' => 'The basic information about the application.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the application. Valid values:'."\n" + ."\n" + .'* creating: The application is being created.'."\n" + .'* failed: The application failed to be created.'."\n" + .'* created: The application is created.'."\n", 'type' => 'string', 'example' => 'created', 'title' => ''], + 'GatewayType' => ['description' => 'The type of the gateway. Valid values:'."\n" + ."\n" + .'* l7: Layer 7 gateway.'."\n" + .'* l4: Layer 4 gateway.'."\n", 'type' => 'string', 'example' => 'l7', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the application was created.'."\n", 'type' => 'string', 'example' => '2023-07-25T05:58:05Z', 'title' => ''], + 'VersionCount' => ['description' => 'The number of versions of the application.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DomainName' => ['description' => 'The domain name that is associated with the application. If no domain name is associated with the application, the value is an empty string.'."\n", 'type' => 'string', 'example' => 'www.1feel.cn', 'title' => ''], + 'Remarks' => ['description' => 'The remarks about the application.'."\n", 'type' => 'string', 'example' => 'test app', 'title' => ''], + 'ServicePort' => ['description' => 'The server port. Valid values: 1 to 65535.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'AppId' => ['description' => 'The application ID.'."\n", 'type' => 'string', 'example' => 'app-88068867578379****', 'title' => ''], + 'TargetPort' => ['description' => 'The backend port, which is also the service port of the application. Valid values: 1 to 65535.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'QuicCid' => ['description' => 'Indicates whether QUIC is enabled.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], + 'Name' => ['description' => 'The application name.'."\n", 'type' => 'string', 'example' => 'test-app1', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the application was last modified. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2023-03-26T02:35:58Z', 'title' => ''], + 'HealthCheck' => [ + 'description' => 'The information about health checks.'."\n", + 'type' => 'object', + 'properties' => [ + 'Timeout' => ['description' => 'The timeout period of the health check. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'Type' => ['description' => 'The health check type. Valid values:'."\n" + ."\n" + .'* l7'."\n" + .'* l4'."\n", 'type' => 'string', 'example' => 'l7', 'title' => ''], + 'Host' => ['description' => 'The domain name that is used for health checks.'."\n", 'type' => 'string', 'example' => 'test.com', 'title' => ''], + 'Interval' => ['description' => 'The interval between health checks. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'SuccTimes' => ['description' => 'The number of consecutive successful health checks required for an application to be considered as healthy.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'Method' => ['description' => 'The HTTP method that the health check request uses.'."\n", 'type' => 'string', 'example' => 'HEAD', 'title' => ''], + 'HttpCode' => ['description' => 'The range of health check status codes that indicate successful health checks.'."\n", 'type' => 'string', 'example' => 'http_2xx', 'title' => ''], + 'FailTimes' => ['description' => 'The number of consecutive failed health checks required for an application to be considered as unhealthy.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'Port' => ['description' => 'The health check port.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'Uri' => ['description' => 'The health check URL.'."\n", 'type' => 'string', 'example' => '/health_check', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter.appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ], + 404 => [ + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + '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"}]', + 'title' => 'GetEdgeContainerApp', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEdgeContainerApp'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetEdgeContainerApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetEdgeContainerAppLogRiver' => [ + 'summary' => 'Retrieves the log collection configuration of an edge container application.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -39062,141 +22251,144 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeCode' => '249444', + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', + 'schema' => ['description' => 'The application ID. You can call the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation to obtain the application ID.'."\n" + .'AppId is a required parameter. If this parameter is not specified, the API returns InvalidParameter.appid (400). You can call the ListEdgeContainerApps operation to obtain a valid AppId..', 'type' => 'string', 'required' => false, 'example' => 'app-880688675****88', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the application. To obtain the application ID, call the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.', - 'type' => 'string', - 'required' => true, - 'example' => 'app-88068867578379****', 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9'], + 'Stdout' => ['description' => 'Indicates whether standard output collection is enabled for the container.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'Path' => ['description' => 'The log file path of the container. The path must be an absolute path that starts with a forward slash (/). Asterisks (*) and question marks (?) can be used as wildcards.', 'type' => 'string', 'example' => '/root/hello.log', 'title' => ''], + ], + 'example' => '', ], ], ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter.appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', 'description' => 'Invalid parameter. Check the parameter configuration.'], + ], + 404 => [ + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"Stdout\\": false,\\n \\"Path\\": \\"/root/hello.log\\"\\n}","type":"json"}]', + 'title' => 'Retrieve edge container log collection configuration', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEdgeContainerAppLogRiver'], + ], + ], + 'ramActions' => [], + ], + 'GetEdgeContainerAppResourceCapacity' => [ + 'summary' => 'Get the resource capacity of an edge container application', + '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' => 'The application ID. You can call the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) API operation to obtain the application ID.'."\n" + ."\n" + .'>If ListEdgeContainerApps returns an empty list, call CreateEdgeContainerApp first to create an application and use the returned AppId.', 'type' => 'string', 'required' => true, 'example' => 'app-88068867578379****', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response schema.', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '50423A7F-A83D-1E24-B80E-86DD25790759'."\n", - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '50423A7F-A83D-1E24-B80E-86DD25790759'."\n"], 'Regions' => [ - 'description' => 'The available regions.', + 'description' => 'The available regions.'."\n" + ."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Region' => [ - 'description' => 'The Chinese mainland:'."\n" - ."\n" - .'- huadong: East China'."\n" - ."\n" - .'- huanan: South China'."\n" - ."\n" - .'- huazhong: Central China'."\n" - ."\n" - .'- huabei: North China'."\n" - ."\n" - .'- xibei: Northwest China'."\n" - ."\n" - .'- xinan: Southwest China'."\n" - ."\n" - .'- dongbei: Northeast China'."\n" - ."\n" - .'Special administrative regions and regions outside the Chinese mainland:'."\n" - ."\n" - .'- tw: Taiwan (China)'."\n" - ."\n" - .'- mo: Macao (China)'."\n" - ."\n" - .'- hk: Hong Kong (China)'."\n" - ."\n" - .'- jp: Japan'."\n" - ."\n" - .'- us: US'."\n" - ."\n" - .'- th: Thailand'."\n" - ."\n" - .'- kr: South Korea'."\n" - ."\n" - .'- ru: Russia'."\n" - ."\n" - .'- sg: Singapore'."\n" - ."\n" - .'- fr: France'."\n" - ."\n" - .'- es: Spain'."\n" - ."\n" - .'- it: Italy'."\n" - ."\n" - .'- se: Sweden'."\n" - ."\n" - .'- ae: UAE'."\n" - ."\n" - .'- id: Indonesia'."\n" - ."\n" - .'- cl: Chile'."\n" - ."\n" - .'- ph: Philippines'."\n" - ."\n" - .'- my: Malaysia'."\n" - ."\n" - .'- vn: Vietnam'."\n" - ."\n" - .'- ar: Argentina'."\n" - ."\n" - .'- au: Australia'."\n" - ."\n" - .'- br: Brazil'."\n" - ."\n" - .'- co: Colombia'."\n" - ."\n" - .'- de: Germany'."\n" - ."\n" - .'- gb: UK'."\n" - ."\n" - .'- pe: Peru'."\n" - ."\n" - .'- sa: Saudi Arabia'."\n" - ."\n" - .'- nl: Netherlands'."\n" - ."\n" - .'- za: South Africa', - 'type' => 'string', - 'example' => 'huadong', - 'title' => '', - ], - 'Isp' => [ - 'description' => 'The carrier. This parameter is returned only for regions in the Chinese mainland. Valid values:'."\n" - ."\n" - .'- cmcc: China Mobile'."\n" - ."\n" - .'- chinanet: China Telecom'."\n" - ."\n" - .'- unicom: China Unicom', - 'type' => 'string', - 'example' => 'unicom', - 'title' => '', - ], - 'Replicas' => [ - 'description' => 'The number of container replicas that can be deployed.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - 'title' => '', - ], + 'Region' => ['description' => 'Chinese mainland:'."\n" + .'- East China: huadong'."\n" + .'- South China: huanan'."\n" + .'- Central China: huazhong'."\n" + .'- North China: huabei'."\n" + .'- Northwest China: xibei'."\n" + .'- Southwest China: xinan'."\n" + .'- Northeast China: dongbei'."\n" + ."\n" + .'Special administrative regions and overseas:'."\n" + ."\n" + .'- Taiwan (China): tw'."\n" + .'- Macao (China): mo'."\n" + .'- Hong Kong (China): hk'."\n" + .'- Japan: jp'."\n" + .'- United States: us'."\n" + .'- Thailand: th'."\n" + .'- South Korea: kr'."\n" + .'- Russia: ru'."\n" + .'- Singapore: sg'."\n" + .'- France: fr'."\n" + .'- Spain: es'."\n" + .'- Italy: it'."\n" + .'- Sweden: se'."\n" + .'- United Arab Emirates: ae'."\n" + .'- Indonesia: id'."\n" + .'- Chile: cl'."\n" + .'- Philippines: ph'."\n" + .'- Malaysia: my'."\n" + .'- Vietnam: vn'."\n" + .'- Argentina: ar'."\n" + .'- Australia: au'."\n" + .'- Brazil: br'."\n" + .'- Colombia: co'."\n" + .'- Germany: de'."\n" + .'- United Kingdom: gb'."\n" + .'- Peru: pe'."\n" + .'- Saudi Arabia: sa'."\n" + .'- Netherlands: nl'."\n" + .'- South Africa: za', 'type' => 'string', 'example' => 'huadong', 'title' => ''], + 'Isp' => ['description' => 'The following Internet service providers (ISPs) are supported. This field is not returned for regions outside the Chinese mainland.'."\n" + .'ISPs:'."\n" + ."\n" + .'- China Mobile: cmcc'."\n" + .'- China Telecom: chinanet'."\n" + .'- China Unicom: unicom', 'type' => 'string', 'example' => 'unicom', 'title' => ''], + 'Replicas' => ['description' => 'The number of container replicas that can be deployed.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''], ], 'description' => '', 'title' => '', @@ -39212,50 +22404,29 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', - 'description' => 'Invalid parameter. Check the parameter configuration.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], - [ - 'errorCode' => 'InvalidParameter.Appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the input application ID is incorrect. You can use the ListEdgeContainerApps API to obtain the application ID.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', 'description' => 'Invalid parameter. Check the parameter configuration.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['errorCode' => 'InvalidParameter.Appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the input application ID is incorrect. You can use the ListEdgeContainerApps API to obtain the application ID.'], ], 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'GetEdgeContainerAppResourceCapacity', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get the resource capacity of an edge container application', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEdgeContainerAppResourceCapacity'], + ], ], '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' => 'Obtain the resource reservation configuration of the edge container.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Retrieves the resource reservation configuration of an edge container application.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -39268,124 +22439,81 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '265068', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'app-88068867578379****', - 'title' => '', - ], + 'schema' => ['description' => 'The application ID. You can call the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation to obtain the application ID.'."\n" + .'>This parameter is required. If this parameter is not specified, the service returns InvalidParameter.Appid (400).'."\n" + .'If no applications exist under your account, call CreateEdgeContainerApp to create an application first, and then call ListEdgeContainerApps to obtain the AppId.'."\n" + .'.', 'type' => 'string', 'required' => false, 'example' => 'app-88068867578379****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n", - ], - 'Enable' => [ - 'description' => 'Whether to enable resource reservation.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], - 'Forever' => [ - 'description' => 'Whether to enable resource reservation permanently.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], - 'DurationTime' => [ - 'description' => 'The end time of the reservation. The input is UTC time. It takes +8 hours to enter Beijing time. For example, if the current time is 2006-01-02 06:04:05 , you need to enter "2006-01-02T14:04:05Z".'."\n", - 'type' => 'string', - 'example' => '2006-01-02T15:04:05Z', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n"], + 'Enable' => ['description' => 'Indicates whether resource reservation is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Forever' => ['description' => 'Indicates whether the reservation is permanently enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'DurationTime' => ['description' => 'The reservation expiration time. This parameter uses UTC time. To convert from UTC+8, add 8 hours. For example, if the current UTC+8 time is 2006-01-02 06:04:05, enter "2006-01-02T14:04:05Z".', 'type' => 'string', 'example' => '2006-01-02T15:04:05Z', 'title' => ''], 'ReserveSet' => [ - 'description' => 'Reserved resource list.'."\n", + 'description' => 'The list of reserved resources.', 'type' => 'array', 'items' => [ - 'description' => 'The reserved region object.'."\n", + 'description' => 'The reserved region object.', 'type' => 'object', 'properties' => [ - 'Region' => [ - 'description' => 'Chinese mainland:'."\n" - ."\n" - .'* East China: huadong'."\n" - .'* South China: huanan'."\n" - .'* Central China: huazhong'."\n" - .'* North China: huabei'."\n" - .'* Northwest: xibei'."\n" - .'* Southwest: xinan'."\n" - .'* Northeast China: dongbei'."\n" - ."\n" - .'Special Administrative Regions and Overseas:'."\n" - ."\n" - .'* Taiwan, China: tw'."\n" - .'* Macau China: mo'."\n" - .'* Hong Kong, China: hk'."\n" - .'* Japan: jp'."\n" - .'* United States: us'."\n" - .'* Thailand: th'."\n" - .'* Korea: kr'."\n" - .'* Russia: ru'."\n" - .'* Singapore: sg'."\n" - .'* France: fr'."\n" - .'* Spain: es'."\n" - .'* Italy: it'."\n" - .'* Sweden: se'."\n" - .'* UAE: ae'."\n" - .'* Indonesia: id'."\n" - .'* Chile: cl'."\n" - .'* Philippines: ph'."\n" - .'* Malaysia: my'."\n" - .'* Vietnam: vn'."\n" - .'* Argentina: ar'."\n" - .'* Australia: au'."\n" - .'* Brazil: br'."\n" - .'* Colombia: co'."\n" - .'* Germany: de'."\n" - .'* UK: gb'."\n" - .'* Peru: pe'."\n" - .'* Saudi Arabia: sa'."\n" - .'* Netherlands: nl'."\n" - .'* South Africa: za'."\n", - 'type' => 'string', - 'example' => 'huazhong', - 'title' => '', - ], - 'Isp' => [ - 'description' => 'The following ISPs are supported. You do not need to enter this field for overseas and special administrative regions. ISP:'."\n" - ."\n" - .'* China Mobile: cmcc'."\n" - .'* China Telecom: chinanet'."\n" - .'* China Unicom: unicom'."\n", - 'type' => 'string', - 'example' => 'cmcc', - 'title' => '', - ], - 'Replicas' => [ - 'description' => 'The number of container replicas.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], + 'Region' => ['description' => 'The Chinese mainland:'."\n" + .'- East China: huadong'."\n" + .'- South China: huanan'."\n" + .'- Central China: huazhong'."\n" + .'- North China: huabei'."\n" + .'- Northwest China: xibei'."\n" + .'- Southwest China: xinan'."\n" + .'- Northeast China: dongbei'."\n" + ."\n" + .'Special administrative regions and outside China:'."\n" + .'- Taiwan (China): tw'."\n" + .'- Macao (China): mo'."\n" + .'- Hong Kong (China): hk'."\n" + .'- Japan: jp'."\n" + .'- United States: us'."\n" + .'- Thailand: th'."\n" + .'- South Korea: kr'."\n" + .'- Russia: ru'."\n" + .'- Singapore: sg'."\n" + .'- France: fr'."\n" + .'- Spain: es'."\n" + .'- Italy: it'."\n" + .'- Sweden: se'."\n" + .'- United Arab Emirates: ae'."\n" + .'- Indonesia: id'."\n" + .'- Chile: cl'."\n" + .'- Philippines: ph'."\n" + .'- Malaysia: my'."\n" + .'- Vietnam: vn'."\n" + .'- Argentina: ar'."\n" + .'- Australia: au'."\n" + .'- Brazil: br'."\n" + .'- Colombia: co'."\n" + .'- Germany: de'."\n" + .'- United Kingdom: gb'."\n" + .'- Peru: pe'."\n" + .'- Saudi Arabia: sa'."\n" + .'- Netherlands: nl'."\n" + .'- South Africa: za.', 'type' => 'string', 'example' => 'huazhong', 'title' => ''], + 'Isp' => ['description' => 'The following Internet service providers (ISPs) are supported. This parameter is not required for regions outside the Chinese mainland.'."\n" + .'Valid values:'."\n" + .'- cmcc: China Mobile'."\n" + .'- chinanet: China Telecom'."\n" + .'- unicom: China Unicom.', 'type' => 'string', 'example' => 'cmcc', 'title' => ''], + 'Replicas' => ['description' => 'The number of container replicas.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', @@ -39400,71 +22528,28 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', - 'description' => 'Invalid parameter. Check the parameter configuration.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], - [ - 'errorCode' => 'InvalidParameter.Appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the input application ID is incorrect. You can use the ListEdgeContainerApps API to obtain the application ID.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', 'description' => 'Invalid parameter. Check the parameter configuration.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['errorCode' => 'InvalidParameter.Appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the input application ID is incorrect. You can use the ListEdgeContainerApps API to obtain the application ID.'], ], 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], ], '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"}]', - 'title' => 'GetEdgeContainerAppResourceReserve', + 'title' => 'Get edge container application resource reservation configuration', '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEdgeContainerAppResourceReserve'], ], ], + 'ramActions' => [], ], 'GetEdgeContainerAppResourceStatus' => [ 'summary' => 'Obtains the distribution of edge container application resources.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -39477,21 +22562,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '267316', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'app-96253477062511****', - 'title' => '', - ], + 'schema' => ['description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'app-96253477062511****', 'title' => ''], ], ], 'responses' => [ @@ -39501,12 +22578,7 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74'], 'Regions' => [ 'description' => 'Queries the regions of deployment.'."\n", 'type' => 'array', @@ -39514,88 +22586,56 @@ 'description' => 'Deployment regions.'."\n", 'type' => 'object', 'properties' => [ - 'Region' => [ - 'description' => 'Chinese mainland:'."\n" - ."\n" - .'* East China: huadong'."\n" - .'* South China: huanan'."\n" - .'* Central China: huazhong'."\n" - .'* North China: huabei'."\n" - .'* Northwest China: xibei'."\n" - .'* Southwest China: xinan'."\n" - .'* Northeast China: dongbei'."\n" - ."\n" - .'Special Administrative Regions and Overseas:'."\n" - ."\n" - .'* Taiwan, China: tw'."\n" - .'* Macau, China: mo'."\n" - .'* Hong Kong, China: hk'."\n" - .'* Japan: jp'."\n" - .'* United States: us'."\n" - .'* Thailand: th'."\n" - .'* Korea: kr'."\n" - .'* Russia: ru'."\n" - .'* Singapore: sg'."\n" - .'* France: fr'."\n" - .'* Spain: es'."\n" - .'* Italy: it'."\n" - .'* Sweden: se'."\n" - .'* UAE: ae'."\n" - .'* Indonesia: id'."\n" - .'* Chile: cl'."\n" - .'* Philippines: ph'."\n" - .'* Malaysia: my'."\n" - .'* Vietnam: vn'."\n" - .'* Argentina: AR'."\n" - .'* Australia: au'."\n" - .'* Brazil: br'."\n" - .'* Colombia: co'."\n" - .'* Germany: de'."\n" - .'* UK: GB'."\n" - .'* Peru: pe'."\n" - .'* Saudi Arabia: sa'."\n" - .'* Netherlands: nl'."\n" - .'* South Africa: za'."\n", - 'type' => 'string', - 'example' => 'huadong', - 'title' => '', - ], - 'Isp' => [ - 'description' => 'Supported ISPs are as follows. The parameter is left empty for regions outside the Chinese mainland. ISP:'."\n" - ."\n" - .'* China Mobile: cmcc'."\n" - .'* China Telecom: chinanet'."\n" - .'* China Unicom: unicom'."\n", - 'type' => 'string', - 'example' => 'unicom', - 'title' => '', - ], - 'Total' => [ - 'description' => 'The number of replicas that are deployed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Ready' => [ - 'description' => 'The number of ready replicas.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'IsStaging' => [ - 'description' => 'Whether it is a test environment.'."\n", - 'type' => 'boolean', - 'example' => 'false', - 'title' => '', - ], - 'IsOffline' => [ - 'description' => 'Whether smooth offline is being used.'."\n", - 'type' => 'boolean', - 'example' => 'false', - 'title' => '', - ], + 'Region' => ['description' => 'Chinese mainland:'."\n" + ."\n" + .'* East China: huadong'."\n" + .'* South China: huanan'."\n" + .'* Central China: huazhong'."\n" + .'* North China: huabei'."\n" + .'* Northwest China: xibei'."\n" + .'* Southwest China: xinan'."\n" + .'* Northeast China: dongbei'."\n" + ."\n" + .'Special Administrative Regions and Overseas:'."\n" + ."\n" + .'* Taiwan, China: tw'."\n" + .'* Macau, China: mo'."\n" + .'* Hong Kong, China: hk'."\n" + .'* Japan: jp'."\n" + .'* United States: us'."\n" + .'* Thailand: th'."\n" + .'* Korea: kr'."\n" + .'* Russia: ru'."\n" + .'* Singapore: sg'."\n" + .'* France: fr'."\n" + .'* Spain: es'."\n" + .'* Italy: it'."\n" + .'* Sweden: se'."\n" + .'* UAE: ae'."\n" + .'* Indonesia: id'."\n" + .'* Chile: cl'."\n" + .'* Philippines: ph'."\n" + .'* Malaysia: my'."\n" + .'* Vietnam: vn'."\n" + .'* Argentina: AR'."\n" + .'* Australia: au'."\n" + .'* Brazil: br'."\n" + .'* Colombia: co'."\n" + .'* Germany: de'."\n" + .'* UK: GB'."\n" + .'* Peru: pe'."\n" + .'* Saudi Arabia: sa'."\n" + .'* Netherlands: nl'."\n" + .'* South Africa: za'."\n", 'type' => 'string', 'example' => 'huadong', 'title' => ''], + 'Isp' => ['description' => 'Supported ISPs are as follows. The parameter is left empty for regions outside the Chinese mainland. ISP:'."\n" + ."\n" + .'* China Mobile: cmcc'."\n" + .'* China Telecom: chinanet'."\n" + .'* China Unicom: unicom'."\n", 'type' => 'string', 'example' => 'unicom', 'title' => ''], + 'Total' => ['description' => 'The number of replicas that are deployed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Ready' => ['description' => 'The number of ready replicas.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'IsStaging' => ['description' => 'Whether it is a test environment.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'IsOffline' => ['description' => 'Whether smooth offline is being used.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', @@ -39610,46 +22650,22 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', - 'description' => 'Invalid parameter. Check the parameter configuration.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], - [ - 'errorCode' => 'InvalidParameter.Appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the input application ID is incorrect. You can use the ListEdgeContainerApps API to obtain the application ID.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', 'description' => 'Invalid parameter. Check the parameter configuration.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['errorCode' => 'InvalidParameter.Appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the input application ID is incorrect. You can use the ListEdgeContainerApps API to obtain the application ID.'], ], 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], ], '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"}]', 'title' => 'GetEdgeContainerAppResourceStatus', 'changeSet' => [ - [ - 'createdAt' => '2025-07-09T17:07:02.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-07-09T17:07:02.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '20', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetEdgeContainerAppResourceStatus', - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEdgeContainerAppResourceStatus'], ], ], 'ramActions' => [ @@ -39660,12 +22676,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -39673,14 +22684,8 @@ ], 'GetEdgeContainerAppStatus' => [ 'summary' => 'Queries the status information about a containerized application, including the deployment, release, and rollback of the application.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -39692,34 +22697,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238718', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'app-88068867578379****', - 'maxLength' => 64, - 'minLength' => 20, - 'title' => '', - ], + 'schema' => ['description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'app-88068867578379****', 'maxLength' => 64, 'minLength' => 20, 'title' => ''], ], [ 'name' => 'PublishEnv', 'in' => 'query', - 'schema' => [ - 'description' => 'The release environment. Valid values: prod and staging.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'staging', - 'title' => '', - ], + 'schema' => ['description' => 'The release environment. Valid values: prod and staging.'."\n", 'type' => 'string', 'required' => false, 'example' => 'staging', 'title' => ''], ], ], 'responses' => [ @@ -39727,141 +22716,59 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247B78', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247B78', 'title' => ''], 'AppStatus' => [ 'description' => 'The status of the application.'."\n", 'type' => 'object', 'properties' => [ - 'PublishPercentage' => [ - 'description' => 'The release percentage of the application.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50%', - 'title' => '', - ], - 'RollbackTime' => [ - 'description' => 'The time when the last rollback was performed.'."\n", - 'type' => 'string', - 'example' => '2024-07-25T05:58:05Z'."\n", - 'title' => '', - ], - 'PublishEnv' => [ - 'description' => 'The environment to which the application was released. Valid values:'."\n" - ."\n" - .'* **prod**: the production environment.'."\n" - .'* **staging**: the staging environment.'."\n", - 'type' => 'string', - 'example' => 'prod', - 'title' => '', - ], - 'PublishingVersion' => [ - 'description' => 'The release version of the application.'."\n", - 'type' => 'string', - 'example' => 'ver-123123123123****'."\n", - 'title' => '', - ], - 'BaseLineVersion' => [ - 'description' => 'The base version of the application.'."\n", - 'type' => 'string', - 'example' => 'ver-123123123123****'."\n", - 'title' => '', - ], - 'PublishStatus' => [ - 'description' => 'The release status of the application. Valid values:'."\n" - ."\n" - .'* **publishing**'."\n" - .'* **published**'."\n" - .'* **rollbacking**'."\n" - .'* **rollbacked**'."\n", - 'type' => 'string', - 'example' => 'pubishing', - 'title' => '', - ], - 'DeployTime' => [ - 'description' => 'The time when the application was deployed. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2024-07-25T05:58:05Z'."\n", - 'title' => '', - ], - 'PublishTime' => [ - 'description' => 'The time when the application was released. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2024-07-25T05:58:05Z'."\n", - 'title' => '', - ], - 'DeployedVersion' => [ - 'description' => 'The release version of the application.'."\n", - 'type' => 'string', - 'example' => 'ver-123123123123****', - 'title' => '', - ], - 'ExpectPercentage' => [ - 'description' => 'The expected release percentage of the application.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50%', - 'title' => '', - ], - 'DeployStatus' => [ - 'description' => 'The deployment status of the application.'."\n" - ."\n" - .'* **undeploy**: The application is not deployed.'."\n" - .'* **deploying**: The application is being deployed.'."\n" - .'* **deployed**: The application is deployed.'."\n" - .'* **undeploying**: The deployment is being canceled.'."\n", - 'type' => 'string', - 'example' => 'undeploy', - 'title' => '', - ], - 'UnDeployTime' => [ - 'description' => 'The time when the application deployment was canceled. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2024-07-25T05:58:05Z'."\n", - 'title' => '', - ], - 'PublishType' => [ - 'description' => 'Specifies how the version is released. Valid values:'."\n" - ."\n" - .'* percentage: releases the version by percentage.'."\n" - .'* region: releases the version by region.'."\n" - ."\n" - .'If you do not specify this parameter, the version is released by percentage by default.'."\n", - 'type' => 'string', - 'example' => 'percentage', - 'title' => '', - ], - 'Regions' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Region' => [ - 'description' => 'The regions to which the version is released.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The region name.'."\n", - 'type' => 'string', - 'example' => 'jiangsu', - 'title' => '', - ], - 'title' => '', - 'example' => '', - ], - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'FullRelease' => [ - 'description' => 'Specifies whether to fully release the version. This parameter takes effect only when PublishType is set to region.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'PublishPercentage' => ['description' => 'The release percentage of the application.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '50%', 'title' => ''], + 'RollbackTime' => ['description' => 'The time when the last rollback was performed.'."\n", 'type' => 'string', 'example' => '2024-07-25T05:58:05Z'."\n", 'title' => ''], + 'PublishEnv' => ['description' => 'The environment to which the application was released. Valid values:'."\n" + ."\n" + .'* **prod**: the production environment.'."\n" + .'* **staging**: the staging environment.'."\n", 'type' => 'string', 'example' => 'prod', 'title' => ''], + 'PublishingVersion' => ['description' => 'The release version of the application.'."\n", 'type' => 'string', 'example' => 'ver-123123123123****'."\n", 'title' => ''], + 'BaseLineVersion' => ['description' => 'The base version of the application.'."\n", 'type' => 'string', 'example' => 'ver-123123123123****'."\n", 'title' => ''], + 'PublishStatus' => ['description' => 'The release status of the application. Valid values:'."\n" + ."\n" + .'* **publishing**'."\n" + .'* **published**'."\n" + .'* **rollbacking**'."\n" + .'* **rollbacked**'."\n", 'type' => 'string', 'example' => 'pubishing', 'title' => ''], + 'DeployTime' => ['description' => 'The time when the application was deployed. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2024-07-25T05:58:05Z'."\n", 'title' => ''], + 'PublishTime' => ['description' => 'The time when the application was released. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2024-07-25T05:58:05Z'."\n", 'title' => ''], + 'DeployedVersion' => ['description' => 'The release version of the application.'."\n", 'type' => 'string', 'example' => 'ver-123123123123****', 'title' => ''], + 'ExpectPercentage' => ['description' => 'The expected release percentage of the application.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '50%', 'title' => ''], + 'DeployStatus' => ['description' => 'The deployment status of the application.'."\n" + ."\n" + .'* **undeploy**: The application is not deployed.'."\n" + .'* **deploying**: The application is being deployed.'."\n" + .'* **deployed**: The application is deployed.'."\n" + .'* **undeploying**: The deployment is being canceled.'."\n", 'type' => 'string', 'example' => 'undeploy', 'title' => ''], + 'UnDeployTime' => ['description' => 'The time when the application deployment was canceled. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2024-07-25T05:58:05Z'."\n", 'title' => ''], + 'PublishType' => ['description' => 'Specifies how the version is released. Valid values:'."\n" + ."\n" + .'* percentage: releases the version by percentage.'."\n" + .'* region: releases the version by region.'."\n" + ."\n" + .'If you do not specify this parameter, the version is released by percentage by default.'."\n", 'type' => 'string', 'example' => 'percentage', 'title' => ''], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => 'The regions to which the version is released.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The region name.'."\n", 'type' => 'string', 'example' => 'jiangsu', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', 'title' => '', + 'example' => '', ], + 'FullRelease' => ['description' => 'Specifies whether to fully release the version. This parameter takes effect only when PublishType is set to region.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', @@ -39875,30 +22782,14 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', - 'description' => 'Invalid parameter. Check the parameter configuration.', - ], + ['errorCode' => 'InvalidParameter.appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', 'description' => 'Invalid parameter. Check the parameter configuration.'], ], 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], 'eventInfo' => [ @@ -39910,12 +22801,7 @@ 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetEdgeContainerAppStatus', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEdgeContainerAppStatus'], ], ], 'ramActions' => [ @@ -39926,12 +22812,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -39939,13 +22820,8 @@ ], 'GetEdgeContainerAppVersion' => [ 'summary' => 'Queries the information about a version of a containerized application. You can select an application version to release based on the version information.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -39957,36 +22833,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238877', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'app-88068867578379****', - 'maxLength' => 64, - 'minLength' => 20, - 'title' => '', - ], + 'schema' => ['description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 20, 'example' => 'app-88068867578379****', 'title' => ''], ], [ 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The version ID, which can be obtained by calling the [ListEdgeContainerAppVersions](~~ListEdgeContainerAppVersions~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ver-87962637161651****', - 'maxLength' => 64, - 'minLength' => 20, - 'title' => '', - ], + 'schema' => ['description' => 'The version ID, which can be obtained by calling the [ListEdgeContainerAppVersions](~~ListEdgeContainerAppVersions~~) operation.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 20, 'example' => 'ver-87962637161651****', 'title' => ''], ], ], 'responses' => [ @@ -39994,285 +22852,76 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', 'title' => ''], 'Version' => [ - 'description' => 'The information about the version.'."\n", + 'description' => 'The information about the version.', 'type' => 'object', 'properties' => [ - 'LastPublishTime' => [ - 'description' => 'The time when the version was last released. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-07-25T04:58:05Z', - 'title' => '', - ], - 'PublishTime' => [ - 'description' => 'The time when the version was released. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-11-14T02:04:03Z', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the current version. Valid values:'."\n" - ."\n" - .'* created: The version is created.'."\n" - .'* failed: The version failed to be created.'."\n" - .'* creating: The version is being created.'."\n", - 'type' => 'string', - 'example' => 'created', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the version was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-07-01T09:32:33Z', - 'title' => '', - ], - 'AppId' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'example' => 'app-88068867578379****', - 'title' => '', - ], - 'VersionId' => [ - 'description' => 'The ID of the created version.'."\n", - 'type' => 'string', - 'example' => 'ver-87962637161651****', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The version name.'."\n", - 'type' => 'string', - 'example' => 'test', - 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'The time when the version was last modified. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2021-12-03T10:52:52Z', - 'title' => '', - ], - 'Remarks' => [ - 'description' => 'The remarks.'."\n", - 'type' => 'string', - 'example' => 'aaa', - 'title' => '', - ], + 'LastPublishTime' => ['description' => 'The time when the version was last released. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2023-07-25T04:58:05Z', 'title' => ''], + 'PublishTime' => ['description' => 'The time when the version was released. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2022-11-14T02:04:03Z', 'title' => ''], + 'Status' => ['description' => 'The status of the current version. Valid values:'."\n" + ."\n" + .'- created: The version is created.'."\n" + ."\n" + .'- failed: The version failed to be created.'."\n" + ."\n" + .'- creating: The version is being created.', 'type' => 'string', 'example' => 'created', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the version was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2022-07-01T09:32:33Z', 'title' => ''], + 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'app-88068867578379****', 'title' => ''], + 'VersionId' => ['description' => 'The ID of the created version.', 'type' => 'string', 'example' => 'ver-87962637161651****', 'title' => ''], + 'Name' => ['description' => 'The version name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the version was last modified. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2021-12-03T10:52:52Z', 'title' => ''], + 'Remarks' => ['description' => 'The remarks.', 'type' => 'string', 'example' => 'aaa', 'title' => ''], 'Containers' => [ - 'description' => 'The container images deployed for this version.'."\n", + 'description' => 'The container images deployed for this version.', 'type' => 'array', 'items' => [ - 'description' => 'The details of the container image deployed for this version.'."\n", + 'description' => 'The details of the container image deployed for this version.', 'type' => 'object', 'properties' => [ - 'EnvVariables' => [ - 'description' => 'The environment variables.'."\n", - 'type' => 'string', - 'example' => 'ENV=prod', - 'title' => '', - ], - 'Args' => [ - 'description' => 'The arguments that are passed to the container startup command.'."\n", - 'type' => 'string', - 'example' => '-c /path/config.toml', - 'title' => '', - ], - 'Spec' => [ - 'description' => 'The compute specification.'."\n", - 'type' => 'string', - 'example' => '1C2G', - 'title' => '', - ], - 'Storage' => [ - 'description' => 'The storage capacity of the container. Valid values: 0.5G, 10G, 20G, and 30G.'."\n", - 'type' => 'string', - 'example' => '0.5G, 标识存储空间，取值范围（0.5G | 10G | 20G | 30G）', - 'title' => '', - ], - 'IsACRImage' => [ - 'description' => 'Indicates whether the image is a Container Registry image.'."\n", - 'type' => 'boolean', - 'example' => 'false', - 'title' => '', - ], + 'EnvVariables' => ['description' => 'The environment variables.', 'type' => 'string', 'example' => 'ENV=prod', 'title' => ''], + 'Args' => ['description' => 'The arguments that are passed to the container startup command.', 'type' => 'string', 'example' => '-c /path/config.toml', 'title' => ''], + 'Spec' => ['description' => 'The compute specification.', 'type' => 'string', 'example' => '1C2G', 'title' => ''], + 'Storage' => ['description' => 'The storage capacity of the container. Valid values: 0.5G, 10G, 20G, and 30G.', 'type' => 'string', 'example' => '0.5G, 标识存储空间，取值范围（0.5G | 10G | 20G | 30G）', 'title' => ''], + 'IsACRImage' => ['description' => 'Indicates whether the image is a Container Registry image.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'ACRImageInfo' => [ - 'description' => 'The information about the Container Registry image.'."\n", + 'description' => 'The information about the Container Registry image.', 'type' => 'object', 'properties' => [ - 'Domain' => [ - 'description' => 'The domain name of the Container Registry image.'."\n", - 'type' => 'string', - 'example' => '*.mooc.seewo.com', - 'title' => '', - ], - 'InstanceId' => [ - 'description' => 'The ID of the Container Registry instance.'."\n", - 'type' => 'string', - 'example' => 'xcdn-9ak2thl14z5s', - 'title' => '', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - 'title' => '', - ], - 'RepoId' => [ - 'description' => 'The ID of the image repository.'."\n", - 'type' => 'string', - 'example' => 'crr-zeu0xyk28alyxozh', - 'title' => '', - ], - 'RepoName' => [ - 'description' => 'The name of the image repository.'."\n", - 'type' => 'string', - 'example' => 'test_1', - 'title' => '', - ], - 'RepoNamespace' => [ - 'description' => 'The namespace to which the image repository belongs.'."\n", - 'type' => 'string', - 'example' => 'wpy1', - 'title' => '', - ], - 'Tag' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'test-healthy-100-soa-1710987653', - 'title' => '', - ], - 'TagUrl' => [ - 'description' => 'The URL of the Container Registry image tag.'."\n", - 'type' => 'string', - 'example' => 'registry-vpc.cn-shenzhen.aliyuncs.com/lihetech/easywits_server_exam:3.40.2', - 'title' => '', - ], - 'IsEnterpriseRegistry' => [ - 'description' => 'Indicates whether the image is an enterprise-level image.'."\n", - 'type' => 'boolean', - 'example' => 'false', - 'title' => '', - ], + 'Domain' => ['description' => 'The domain name of the Container Registry image.', 'type' => 'string', 'example' => '*.mooc.seewo.com', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the Container Registry instance.', 'type' => 'string', 'example' => 'xcdn-9ak2thl14z5s', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'RepoId' => ['description' => 'The ID of the image repository.', 'type' => 'string', 'example' => 'crr-zeu0xyk28alyxozh', 'title' => ''], + 'RepoName' => ['description' => 'The name of the image repository.', 'type' => 'string', 'example' => 'test_1', 'title' => ''], + 'RepoNamespace' => ['description' => 'The namespace to which the image repository belongs.', 'type' => 'string', 'example' => 'wpy1', 'title' => ''], + 'Tag' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'test-healthy-100-soa-1710987653', 'title' => ''], + 'TagUrl' => ['description' => 'The URL of the Container Registry image tag.', 'type' => 'string', 'example' => 'registry-vpc.cn-shenzhen.aliyuncs.com/lihetech/easywits_server_exam:3.40.2', 'title' => ''], + 'IsEnterpriseRegistry' => ['description' => 'Indicates whether the image is an enterprise-level image.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], - 'Image' => [ - 'description' => 'The image address.'."\n", - 'type' => 'string', - 'example' => 'nginx:1.14.0', - 'title' => '', - ], - 'Command' => [ - 'description' => 'The command that is used to start the container.'."\n", - 'type' => 'string', - 'example' => 'sh abc.sh 1 2 3', - 'title' => '', - ], - 'ProbeType' => [ - 'description' => 'The probe type.'."\n", - 'type' => 'string', - 'example' => 'httpGet', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The version name.'."\n", - 'type' => 'string', - 'example' => 'version01', - 'title' => '', - ], - 'PreStop' => [ - 'description' => 'The command that is run before the container is stopped.'."\n", - 'type' => 'string', - 'example' => 'sh prestop.sh "echo hello world" ', - 'title' => '', - ], - 'PostStart' => [ - 'description' => 'The command that is run before the container is started. Format: `{"exec":{"command":\\["cat","/etc/group"\\]}}`. If you want to cancel this configuration, set the parameter value to `""` or `{}`. If you do not specify this parameter, this configuration is ignored.'."\n", - 'type' => 'string', - 'example' => 'sh poststart.sh "echo hello world" ', - 'title' => '', - ], + 'Image' => ['description' => 'The image address.', 'type' => 'string', 'example' => 'nginx:1.14.0', 'title' => ''], + 'Command' => ['description' => 'The command that is used to start the container.', 'type' => 'string', 'example' => 'sh abc.sh 1 2 3', 'title' => ''], + 'ProbeType' => ['description' => 'The probe type.', 'type' => 'string', 'example' => 'httpGet', 'title' => ''], + 'Name' => ['description' => 'The version name.', 'type' => 'string', 'example' => 'version01', 'title' => ''], + 'PreStop' => ['description' => 'The command that is run before the container is stopped.', 'type' => 'string', 'example' => 'sh prestop.sh "echo hello world" ', 'title' => ''], + 'PostStart' => ['description' => 'The command that is run before the container is started. Format: `{"exec":{"command":\\["cat","/etc/group"\\]}}`. If you want to cancel this configuration, set the parameter value to `""` or `{}`. If you do not specify this parameter, this configuration is ignored.', 'type' => 'string', 'example' => 'sh poststart.sh "echo hello world" ', 'title' => ''], 'ProbeContent' => [ - 'description' => 'The probe content.'."\n", + 'description' => 'The probe content.', 'type' => 'object', 'properties' => [ - 'SuccessThreshold' => [ - 'description' => 'The number of consecutive successful health checks required for a container to be considered as healthy.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Host' => [ - 'description' => 'The domain name that is used for health checks.'."\n", - 'type' => 'string', - 'example' => 'test.com', - 'title' => '', - ], - 'HttpHeaders' => [ - 'description' => 'The request headers that are included in the container health check request.'."\n", - 'type' => 'string', - 'example' => '[{\\"Content-Type\\":\\"application/json', - 'title' => '', - ], - 'Scheme' => [ - 'description' => 'The protocol that the container health check request uses.'."\n", - 'type' => 'string', - 'example' => 'http', - 'title' => '', - ], - 'InitialDelaySeconds' => [ - 'description' => 'The latency for container probe initialization.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], - 'Command' => [ - 'description' => 'The probe command.'."\n", - 'type' => 'string', - 'example' => 'sh test.sh', - 'title' => '', - ], - 'FailureThreshold' => [ - 'description' => 'The number of consecutive failed health checks required for a container to be considered as unhealthy.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'title' => '', - ], - 'TimeoutSeconds' => [ - 'description' => 'The timeout period of the container health check.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'title' => '', - ], - 'Path' => [ - 'description' => 'The path of the container health check.'."\n", - 'type' => 'string', - 'example' => '/health_check', - 'title' => '', - ], - 'Port' => [ - 'description' => 'The port of the container health check. Valid values: **1** to **65535**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - 'title' => '', - ], - 'PeriodSeconds' => [ - 'description' => 'The interval between container health checks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'title' => '', - ], + 'SuccessThreshold' => ['description' => 'The number of consecutive successful health checks required for a container to be considered as healthy.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Host' => ['description' => 'The domain name that is used for health checks.', 'type' => 'string', 'example' => 'test.com', 'title' => ''], + 'HttpHeaders' => ['description' => 'The request headers that are included in the container health check request.', 'type' => 'string', 'example' => '[{\\"Content-Type\\":\\"application/json', 'title' => ''], + 'Scheme' => ['description' => 'The protocol that the container health check request uses.', 'type' => 'string', 'example' => 'http', 'title' => ''], + 'InitialDelaySeconds' => ['description' => 'The latency for container probe initialization.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Command' => ['description' => 'The probe command.', 'type' => 'string', 'example' => 'sh test.sh', 'title' => ''], + 'FailureThreshold' => ['description' => 'The number of consecutive failed health checks required for a container to be considered as unhealthy.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'TimeoutSeconds' => ['description' => 'The timeout period of the container health check.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'Path' => ['description' => 'The path of the container health check.', 'type' => 'string', 'example' => '/health_check', 'title' => ''], + 'Port' => ['description' => 'The port of the container health check. Valid values: **1** to **65535**.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'PeriodSeconds' => ['description' => 'The interval between container health checks.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], ], 'title' => '', 'example' => '', @@ -40297,58 +22946,25 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - ], - [ - 'errorCode' => 'InvalidVersion.NotFound', - 'errorMessage' => 'The version does not exist.', - 'description' => 'This version number does not exist.'."\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' => 'The VersionId parameter 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.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InvalidParameter.appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.'], + ['errorCode' => 'InvalidVersion.NotFound', 'errorMessage' => 'The version does not exist.', 'description' => 'This version number does not exist.'."\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' => 'The VersionId parameter 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.'], ], 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - '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"}]', 'title' => 'GetEdgeContainerAppVersion', 'changeSet' => [ - [ - 'createdAt' => '2024-11-12T02:06:26.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2024-11-12T02:06:26.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetEdgeContainerAppVersion', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEdgeContainerAppVersion'], ], ], 'ramActions' => [ @@ -40359,25 +22975,17 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', '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' => [ - 'summary' => 'Queries regions where a containerized application is deployed based on the application ID.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Retrieves the deployment regions of an edge container application by application ID.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -40390,45 +22998,27 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238476', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GetEdgeContainerDeployRegions', - 'title' => '', - ], + 'schema' => ['description' => 'The application ID. You can call the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation to obtain the application ID.>This parameter is required. If this parameter is not specified, the service returns InvalidParameter.appid (400). The valid format is app-{18-digit number}. You can call the ListEdgeContainerApps operation to obtain the application ID. Example: app-880****75783794688. If you have not activated the Edge Container service, activate it first and then call the CreateEdgeContainerApp operation to create an application and obtain the AppId..', 'type' => 'string', 'required' => false, 'example' => 'GetEdgeContainerDeployRegions', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395'], 'Regions' => [ - 'description' => 'The regions.'."\n", + 'description' => 'The list of regions.', 'type' => 'array', - 'items' => [ - 'description' => 'The queried region.'."\n", - 'type' => 'string', - 'example' => 'zhejiang', - 'title' => '', - ], + 'items' => ['description' => 'The available region.', 'type' => 'string', 'example' => 'zhejiang', 'title' => ''], 'title' => '', 'example' => '', ], @@ -40439,79 +23029,35 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], + ['errorCode' => 'InvalidParameter.appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], ], 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"Regions\\": [\\n \\"zhejiang\\"\\n ]\\n}","type":"json"}]', - 'title' => 'GetEdgeContainerDeployRegions', + 'title' => 'Get edge container application deployment regions', '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEdgeContainerDeployRegions'], ], ], + 'ramActions' => [], ], 'GetEdgeContainerLogs' => [ - 'summary' => 'Queries Edge Container logs.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Retrieves log information for an edge container. You can specify the number of output lines.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -40524,27 +23070,20 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238630', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'app-88068867578379****', - 'title' => '', - ], + 'schema' => ['description' => 'The application ID. You can call the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation to obtain the application ID.', 'type' => 'string', 'required' => true, 'example' => 'app-88068867578379****', 'title' => ''], ], [ 'name' => 'Lines', 'in' => 'query', 'schema' => [ - 'description' => 'The number of log entries to output.'."\n", + 'description' => 'The number of log lines to output.>Valid values: 1 to 5000. If the value exceeds the upper limit, an error is returned..', + 'enumValueTitles' => [], 'type' => 'integer', 'format' => 'int32', 'required' => true, @@ -40556,25 +23095,15 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247B78', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247B78'], 'Items' => [ - 'description' => 'The logs.'."\n", + 'description' => 'The log list.', 'type' => 'array', - 'items' => [ - 'description' => 'The log content.'."\n", - 'type' => 'string', - 'example' => 'hello world.', - 'title' => '', - ], + 'items' => ['description' => 'The log content.', 'type' => 'string', 'example' => 'hello world.', 'title' => ''], 'title' => '', 'example' => '', ], @@ -40585,79 +23114,35 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], + ['errorCode' => 'InvalidParameter.appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], ], 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247B78\\",\\n \\"Items\\": [\\n \\"hello world.\\"\\n ]\\n}","type":"json"}]', - 'title' => 'GetEdgeContainerLogs', + 'title' => 'Retrieve edge container log information', '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEdgeContainerLogs'], ], ], + 'ramActions' => [], ], 'GetEdgeContainerStagingDeployStatus' => [ - 'summary' => 'Queries the deployment status of an application in the staging environment by using the application ID.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Retrieves the staging environment deployment status of an application by application ID.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -40670,118 +23155,71 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238416', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GetEdgeContainerStagingDeployStatus', - 'title' => '', - ], + 'schema' => ['description' => 'The application ID. You can call [ListEdgeContainerApps](~~ListEdgeContainerApps~~) to obtain the application ID.'."\n" + .'>AppId is required. If AppId is not specified, the API returns InvalidParameter.appid (400). You can call ListEdgeContainerApps to obtain the application ID. '."\n" + .'The AppId format is the prefix app- followed by 18 or more digits (at least 20 characters in total). You can obtain the actual value from the AppId field in the ListEdgeContainerApps response.'."\n" + .'Complete call chain example: CreateEdgeContainerApp → Call ListEdgeContainerApps to obtain AppId → GetEdgeContainerStagingDeployStatus.', 'type' => 'string', 'required' => false, 'example' => 'GetEdgeContainerStagingDeployStatus', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Phase' => [ - 'description' => 'The status of the container in the staging environment.'."\n" - ."\n" - .'* NoContainer: created.'."\n" - .'* Running: running.'."\n" - .'* Failed: abnormal.'."\n", - 'type' => 'string', - 'example' => 'Running', - 'title' => '', - ], - 'CreationTimestamp' => [ - 'description' => 'The time when the container was created. The value is a timestamp.'."\n", - 'type' => 'string', - 'example' => '2024-09-24T06:46:35Z', - 'title' => '', - ], - 'Initialized' => [ - 'description' => 'The initialization status of the container.'."\n" - ."\n" - .'* ok'."\n" - .'* unready'."\n", - 'type' => 'string', - 'example' => 'ok', - 'title' => '', - ], - 'Scheduled' => [ - 'description' => 'The scheduling status of the container.'."\n" - ."\n" - .'* ok'."\n" - .'* unready'."\n", - 'type' => 'string', - 'example' => 'ok', - 'title' => '', - ], - 'Ready' => [ - 'description' => 'Indicates whether domain names are associated with the container.'."\n" - ."\n" - .'* ok'."\n" - .'* unready'."\n", - 'type' => 'string', - 'example' => 'ok', - 'title' => '', - ], - 'ContainersReady' => [ - 'description' => 'Indicates whether the container is ready.'."\n" - ."\n" - .'* ok'."\n" - .'* unready'."\n", - 'type' => 'string', - 'example' => 'ok', - 'title' => '', - ], + 'Phase' => ['description' => 'The status of the container in the staging environment. Valid values:'."\n" + .'- NoContainer: no container.'."\n" + .'- Pending: pending deployment.'."\n" + .'- ContainerCreating: the container is being created.'."\n" + .'- Running: running.'."\n" + .'- Succeeded: completed.'."\n" + .'- ImagePullBackOff: image pull failed.'."\n" + .'- CrashLoopBackOff: abnormal container startup.'."\n" + .'- Failed: failed.'."\n" + .'- Unknown: unknown.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'CreationTimestamp' => ['description' => 'The creation time (UNIX timestamp).', 'type' => 'string', 'example' => '2024-09-24T06:46:35Z', 'title' => ''], + 'Initialized' => ['description' => 'The container initialization status. Valid values:'."\n" + ."\n" + .'- **ok**: Succeeded.'."\n" + ."\n" + .'- **unready**: Not completed.', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'Scheduled' => ['description' => 'The container scheduling status. Valid values:'."\n" + ."\n" + .'- **ok**: Succeeded.'."\n" + ."\n" + .'- **unready**: Not completed.', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'Ready' => ['description' => 'Indicates whether the container is ready to receive traffic. Valid values:'."\n" + ."\n" + .'- **ok**: Ready.'."\n" + ."\n" + .'- **unready**: Not ready.', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'ContainersReady' => ['description' => 'Indicates whether the container status is ready. Valid values:'."\n" + ."\n" + .'- **ok**: Ready.'."\n" + ."\n" + .'- **unready**: Not ready.', 'type' => 'string', 'example' => 'ok', 'title' => ''], 'PodRestartState' => [ - 'description' => 'The details of container restart.'."\n", + 'description' => 'The container restart status.', 'type' => 'object', 'properties' => [ - 'RestartCount' => [ - 'description' => 'The number of times that the container restarted.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'LastTerminatedReason' => [ - 'description' => 'The reason for the last restart.'."\n", - 'type' => 'string', - 'example' => 'OOMKilled', - 'title' => '', - ], + 'RestartCount' => ['description' => 'The number of restarts.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'LastTerminatedReason' => ['description' => 'The reason for the last restart.', 'type' => 'string', 'example' => 'OOMKilled', 'title' => ''], ], 'title' => '', 'example' => '', ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2F2C992B-3FE2-5EBB-A61F-F9DD4EB257DA', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2F2C992B-3FE2-5EBB-A61F-F9DD4EB257DA', 'title' => ''], 'VIPs' => [ - 'description' => 'The virtual IP addresses.'."\n", + 'description' => 'The list of VIPs.', 'type' => 'array', - 'items' => [ - 'description' => 'The virtual IP address.'."\n", - 'type' => 'string', - 'example' => '1.1.1.1', - 'title' => '', - ], + 'items' => ['description' => 'VIP', 'type' => 'string', 'example' => '1.1.1.1', 'title' => ''], 'title' => '', 'example' => '', ], @@ -40792,80 +23230,35 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], + ['errorCode' => 'InvalidParameter.appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], ], 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], '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"}]', - 'title' => 'GetEdgeContainerStagingDeployStatus', + 'title' => 'Get application staging environment deployment status', '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEdgeContainerStagingDeployStatus'], ], ], + 'ramActions' => [], ], 'GetEdgeContainerTerminal' => [ - 'summary' => 'Queries the terminal information of a containerized application.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Retrieves terminal information of an edge container application.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -40878,72 +23271,31 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238310', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'app-88068867578379****', - 'title' => '', - ], + 'schema' => ['description' => 'The application ID. You can call the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation to obtain the application ID.'."\n" + .'This parameter is required. If this parameter is not specified, the API returns InvalidParameter.appid(400).'."\n" + .'Full dependency chain: CreateEdgeContainerApp → CreateEdgeContainerAppVersion → PublishEdgeContainerAppVersion → Wait for the container status to become Running → Call this API..', 'type' => 'string', 'required' => false, 'example' => 'app-88068867578379****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9732E117-8A37-49FD-A36F-ABBB87556CA7', - ], - 'Pod' => [ - 'description' => 'The name of the container group.'."\n", - 'type' => 'string', - 'example' => '1775b9e0-8463-457e-89e8-fb7b6d125b2e', - 'title' => '', - ], - 'Cluster' => [ - 'description' => 'The cluster name.'."\n", - 'type' => 'string', - 'example' => 'c497b44c2a59f4ae0bd2826edc40a2c6e', - 'title' => '', - ], - 'Namespace' => [ - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'example' => 'ns1', - 'title' => '', - ], - 'Container' => [ - 'description' => 'The container name.'."\n", - 'type' => 'string', - 'example' => 'worker0', - 'title' => '', - ], - 'SessionId' => [ - 'description' => 'The session ID.'."\n", - 'type' => 'string', - 'example' => 'af22f4xxxxxxxxxxxxxxxxxx', - 'title' => '', - ], - 'Token' => [ - 'description' => 'The information about the shared token.'."\n", - 'type' => 'string', - 'example' => 'af22f4-xxxxx-xxxx-xxxx-xxxx', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9732E117-8A37-49FD-A36F-ABBB87556CA7'], + 'Pod' => ['description' => 'The pod name.', 'type' => 'string', 'example' => '1775b9e0-8463-457e-89e8-fb7b6d125b2e', 'title' => ''], + 'Cluster' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'c497b44c2a59f4ae0bd2826edc40a2c6e', 'title' => ''], + 'Namespace' => ['description' => 'The namespace name.', 'type' => 'string', 'example' => 'ns1', 'title' => ''], + 'Container' => ['description' => 'The container name.', 'type' => 'string', 'example' => 'worker0', 'title' => ''], + 'SessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => 'af22f4xxxxxxxxxxxxxxxxxx', 'title' => ''], + 'Token' => ['description' => 'The sharing token information.', 'type' => 'string', 'example' => 'af22f4-xxxxx-xxxx-xxxx-xxxx', 'title' => ''], ], 'example' => '', ], @@ -40951,93 +23303,47 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], + ['errorCode' => 'InvalidParameter.appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], ], 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], '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"}]', - 'title' => 'GetEdgeContainerTerminal', + 'title' => 'Retrieve edge container application terminal information', '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEdgeContainerTerminal'], ], ], + 'ramActions' => [], ], 'GetErService' => [ - 'summary' => 'Checks the status of Edge Routine.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239198', - 'abilityTreeNodes' => [ - 'FEATUREdcdnGMYWU5', - ], + 'abilityTreeNodes' => ['FEATUREdcdnGMYWU5'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [], @@ -41048,52 +23354,30 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', - ], - 'PlanName' => [ - 'description' => 'The billing mode. Valid values:'."\n" - ."\n" - .'* er_paymode: billed for customers on the China site.'."\n" - .'* er_freemode: free for customers on the China site.'."\n" - .'* er_paymodeintl: billed for customers on the International site.'."\n" - .'* err_freemodeintl: free for customers on the International site'."\n", - 'type' => 'string', - 'example' => 'er_paymode', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The service status. Valid values:'."\n" - ."\n" - .'* Creating'."\n" - .'* Running'."\n" - .'* NotOpened'."\n", - 'type' => 'string', - 'example' => 'Running', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'], + 'PlanName' => ['description' => 'The billing mode. Valid values:'."\n" + ."\n" + .'* er_paymode: billed for customers on the China site.'."\n" + .'* er_freemode: free for customers on the China site.'."\n" + .'* er_paymodeintl: billed for customers on the International site.'."\n" + .'* err_freemodeintl: free for customers on the International site'."\n", 'type' => 'string', 'example' => 'er_paymode', 'title' => ''], + 'Status' => ['description' => 'The service status. Valid values:'."\n" + ."\n" + .'* Creating'."\n" + .'* Running'."\n" + .'* NotOpened'."\n", 'type' => 'string', 'example' => 'Running', 'title' => ''], ], 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\",\\n \\"PlanName\\": \\"er_paymode\\",\\n \\"Status\\": \\"Running\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetErService', + 'summary' => 'Checks the status of Edge Routine.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetErService', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetErService'], ], ], 'ramActions' => [ @@ -41104,179 +23388,52 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'operationType' => 'read', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\",\\n \\"PlanName\\": \\"er_paymode\\",\\n \\"Status\\": \\"Running\\"\\n}","type":"json"}]', ], - 'GetHttpIncomingRequestHeaderModificationRule' => [ - 'summary' => 'Queries the configuration details of an HTTP request header modification rule for a website.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetFailFile' => [ + 'summary' => 'Downloads the failed file for a specified upload task.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '257648', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeCode' => '238908', + 'abilityTreeNodes' => ['FEATUREdcdnBCJPGN', 'FEATUREdcdnRELTJV', 'FEATUREdcdnEWYS3A', 'FEATUREdcdn4TTNAL'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '608665779308176', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can obtain this by calling the [ListSites](~~ListSites~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456789****', 'title' => ''], ], [ - 'name' => 'ConfigId', + 'name' => 'UploadId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the configuration. You can call the ListHttpIncomingRequestHeaderModificationRules operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '433045006266368', - 'title' => '', - ], + 'schema' => ['description' => 'The file upload task ID. You can obtain this by calling the [UploadFile](~~2850466~~) operation to create an upload task, or by calling the [ListUploadTasks](~~2851127~~) operation to query existing tasks.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1593805857882113', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5CC228B4-7A67-4016-9C9F-4A4133494A91', - ], - 'ConfigId' => [ - 'description' => 'The ID of the configuration.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '402411533580288', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'The type of the configuration. Valid values:'."\n" - ."\n" - .'* global: the global configuration.'."\n" - .'* rule: the rule configuration.'."\n", - 'type' => 'string', - 'example' => 'global', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'The order in which the rule is executed. A smaller value gives priority to the rule.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:'."\n" - ."\n" - .'* true: Match all incoming requests.'."\n" - .'* Set the value to a custom expression, for example: (http.host eq "video.example.com"): Match the specified request.'."\n", - 'type' => 'string', - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'The rule name. You do not need to set this parameter when you add global configuration.'."\n", - 'type' => 'string', - 'example' => 'rule_example'."\n", - 'title' => '', - ], - 'RequestHeaderModification' => [ - 'description' => 'The configurations for modifying request headers. You can add, delete, or edit a request header.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The configuration of modifying a request header.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the request header.'."\n", - 'type' => 'string', - 'example' => 'headerName', - 'title' => '', - ], - 'Operation' => [ - 'description' => 'The action. Valid values:'."\n" - ."\n" - .'* add: adds a response header.'."\n" - .'* del: deletes a response header.'."\n" - .'* modify: modifies a response header.'."\n", - 'type' => 'string', - 'example' => 'add', - 'title' => '', - ], - 'Value' => [ - 'description' => 'The value of the request header.'."\n", - 'type' => 'string', - 'example' => 'headValue', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The value type. Valid values:'."\n" - ."\n" - .'* static'."\n" - .'* dynamic'."\n", - 'type' => 'string', - 'example' => 'static', - 'title' => '', - ], - ], - 'title' => '', - 'example' => '', - ], - 'title' => '', - 'example' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'], + 'DownloadLink' => ['description' => 'The download link for the failed task file.', 'type' => 'string', 'example' => 'https://****.oss-cn-shenzhen.aliyuncs.com/fail-1593805857882113?Expires=1708659191&OSSAccessKeyId=**********&Signature=**********', 'title' => ''], ], 'example' => '', ], @@ -41284,15 +23441,24 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'MissingTimeParameter', 'errorMessage' => 'The StartTime and EndTime must be both specified.', 'description' => 'Please provide both a start time and an end time.'], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'DomainNameOverLimit', 'errorMessage' => 'A maximum of 500 domains are supported for each request.', 'description' => 'Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.'], + ['errorCode' => 'InvalidTime', 'errorMessage' => 'The query time cannot exceed the last 3 days.', 'description' => 'The query time cannot exceed the last 3 days.'], + ['errorCode' => 'MissingParameter.ObjectType', 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', 'description' => 'Specify the ObjectType parameter.'], + ['errorCode' => 'InvalidStationParameter', 'errorMessage' => 'The specified Station is invalid.', 'description' => 'The specified node parameter is invalid.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], + ['errorCode' => 'InvalidTaskId.Malformed', 'errorMessage' => 'The specified taskId is invalid.', 'description' => 'The specified task ID is invalid.'], + ['errorCode' => 'InvalidParameters.InvalidUrls', 'errorMessage' => 'The specified urls are invalid.', 'description' => 'The requested URL parameter is invalid.'], ], ], - '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"}]', - 'title' => 'GetHttpIncomingRequestHeaderModificationRule', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"DownloadLink\\": \\"https://****.oss-cn-shenzhen.aliyuncs.com/fail-1593805857882113?Expires=1708659191&OSSAccessKeyId=**********&Signature=**********\\"\\n}","type":"json"}]', + 'title' => 'Get failed file download link', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -41301,30 +23467,20 @@ [ 'operationType' => 'get', 'ramAction' => [ - 'action' => 'esa:GetHttpIncomingRequestHeaderModificationRule', + 'action' => 'esa:GetFailFile', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'operationType' => 'read', ], - 'GetHttpIncomingResponseHeaderModificationRule' => [ - 'summary' => 'Queries the configuration details of an incoming HTTP response header modification rule for a website.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetHttpIncomingRequestHeaderModificationRule' => [ + 'summary' => 'Queries the configuration details of an HTTP request header modification rule for a website.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -41335,37 +23491,130 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '257653', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeCode' => '257648', + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '347168101647504', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '608665779308176', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the configuration. You can call the ListHttpIncomingRequestHeaderModificationRules operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '433045006266368', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The configuration ID. You can call the ListHttpIncomingResponseHeaderModificationRules operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '430509230649344', - 'title' => '', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5CC228B4-7A67-4016-9C9F-4A4133494A91'], + 'ConfigId' => ['description' => 'The ID of the configuration.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '402411533580288', 'title' => ''], + 'ConfigType' => ['description' => 'The type of the configuration. Valid values:'."\n" + ."\n" + .'* global: the global configuration.'."\n" + .'* rule: the rule configuration.'."\n", 'type' => 'string', 'example' => 'global', 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Sequence' => ['description' => 'The order in which the rule is executed. A smaller value gives priority to the rule.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuleEnable' => ['description' => 'Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Valid values:'."\n" + ."\n" + .'* on'."\n" + .'* off'."\n", 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:'."\n" + ."\n" + .'* true: Match all incoming requests.'."\n" + .'* Set the value to a custom expression, for example: (http.host eq "video.example.com"): Match the specified request.'."\n", 'type' => 'string', 'example' => '(http.host eq "video.example.com")', 'title' => ''], + 'RuleName' => ['description' => 'The rule name. You do not need to set this parameter when you add global configuration.'."\n", 'type' => 'string', 'example' => 'rule_example'."\n", 'title' => ''], + 'RequestHeaderModification' => [ + 'description' => 'The configurations for modifying request headers. You can add, delete, or edit a request header.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configuration of modifying a request header.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the request header.'."\n", 'type' => 'string', 'example' => 'headerName', 'title' => ''], + 'Operation' => ['description' => 'The action. Valid values:'."\n" + ."\n" + .'* add: adds a response header.'."\n" + .'* del: deletes a response header.'."\n" + .'* modify: modifies a response header.'."\n", 'type' => 'string', 'example' => 'add', 'title' => ''], + 'Value' => ['description' => 'The value of the request header.'."\n", 'type' => 'string', 'example' => 'headValue', 'title' => ''], + 'Type' => ['description' => 'The value type. Valid values:'."\n" + ."\n" + .'* static'."\n" + .'* dynamic'."\n", 'type' => 'string', 'example' => 'static', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ], + ], + '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"}]', + 'title' => 'GetHttpIncomingRequestHeaderModificationRule', + '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}'], + ], ], ], ], + 'operationType' => 'read', + ], + 'GetHttpIncomingResponseHeaderModificationRule' => [ + 'summary' => 'Queries the configuration details of an incoming HTTP response header modification rule for a website.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257653', + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '347168101647504', 'title' => ''], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => ['description' => 'The configuration ID. You can call the ListHttpIncomingResponseHeaderModificationRules operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '430509230649344', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -41373,66 +23622,23 @@ 'description' => 'The response.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', - ], - 'ConfigId' => [ - 'description' => 'The configuration ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '432637955352576', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'The configuration type. Valid values:'."\n" - ."\n" - .'* global: global configurations.'."\n" - .'* rule: rule configurations.'."\n", - 'type' => 'string', - 'example' => 'rule', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'The version number of the configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'The order in which the rule is executed. A smaller value gives priority to the rule.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Specifies whether to check the image used by the instance supports hot migration. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:'."\n" - ."\n" - .'* true: Match all incoming requests.'."\n" - .'* Set the value to a custom expression, for example, (http.host eq "video.example.com"): Match the specified request.'."\n", - 'type' => 'string', - 'example' => '(http.host eq "video.example.com")'."\n", - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'The rule name. You do not need to set this parameter when you add global configuration.'."\n", - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395'], + 'ConfigId' => ['description' => 'The configuration ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '432637955352576', 'title' => ''], + 'ConfigType' => ['description' => 'The configuration type. Valid values:'."\n" + ."\n" + .'* global: global configurations.'."\n" + .'* rule: rule configurations.'."\n", 'type' => 'string', 'example' => 'rule', 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Sequence' => ['description' => 'The order in which the rule is executed. A smaller value gives priority to the rule.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuleEnable' => ['description' => 'Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Specifies whether to check the image used by the instance supports hot migration. Valid values:'."\n" + ."\n" + .'* on'."\n" + .'* off'."\n", 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:'."\n" + ."\n" + .'* true: Match all incoming requests.'."\n" + .'* Set the value to a custom expression, for example, (http.host eq "video.example.com"): Match the specified request.'."\n", 'type' => 'string', 'example' => '(http.host eq "video.example.com")'."\n", 'title' => ''], + 'RuleName' => ['description' => 'The rule name. You do not need to set this parameter when you add global configuration.'."\n", 'type' => 'string', 'example' => 'rule_example', 'title' => ''], 'ResponseHeaderModification' => [ 'description' => 'The configurations of modifying response headers. You can add, delete, or modify a response header.'."\n", 'type' => 'array', @@ -41440,37 +23646,17 @@ 'description' => 'The configuration of modifying a response header.'."\n", 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the response header.'."\n", - 'type' => 'string', - 'example' => 'headerName', - 'title' => '', - ], - 'Operation' => [ - 'description' => 'The action. Valid values:'."\n" - ."\n" - .'* add: adds a response header.'."\n" - .'* del: deletes a response header.'."\n" - .'* modify: modifies a response header.'."\n", - 'type' => 'string', - 'example' => 'add', - 'title' => '', - ], - 'Value' => [ - 'description' => 'The value of the response header.'."\n", - 'type' => 'string', - 'example' => 'headerValue', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The value type. Valid values:'."\n" - ."\n" - .'* static'."\n" - .'* dynamic'."\n", - 'type' => 'string', - 'example' => 'static', - 'title' => '', - ], + 'Name' => ['description' => 'The name of the response header.'."\n", 'type' => 'string', 'example' => 'headerName', 'title' => ''], + 'Operation' => ['description' => 'The action. Valid values:'."\n" + ."\n" + .'* add: adds a response header.'."\n" + .'* del: deletes a response header.'."\n" + .'* modify: modifies a response header.'."\n", 'type' => 'string', 'example' => 'add', 'title' => ''], + 'Value' => ['description' => 'The value of the response header.'."\n", 'type' => 'string', 'example' => 'headerValue', 'title' => ''], + 'Type' => ['description' => 'The value type. Valid values:'."\n" + ."\n" + .'* static'."\n" + .'* dynamic'."\n", 'type' => 'string', 'example' => 'static', 'title' => ''], ], 'title' => '', 'example' => '', @@ -41485,11 +23671,7 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], '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"}]', @@ -41506,12 +23688,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -41520,12 +23697,8 @@ ], 'GetHttpRequestHeaderModificationRule' => [ 'summary' => 'Retrieves the details of an HTTP request header modification rule for a site.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -41538,34 +23711,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257648', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the site. You can obtain this ID by calling the [ListSites](~~2850189~~) operation.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the site. You can obtain this ID by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration ID. You can obtain this ID by calling the [ListHttpRequestHeaderModificationRules](~~2867483~~) operation.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '3528160969****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID. You can obtain this ID by calling the [ListHttpRequestHeaderModificationRules](~~2867483~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '3528160969****', 'title' => ''], ], ], 'responses' => [ @@ -41575,69 +23732,26 @@ 'description' => 'The response to the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - ], - 'ConfigId' => [ - 'description' => 'The configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3528160969****'."\n", - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'The configuration type. Valid values:'."\n" - ."\n" - .'- global: A global configuration.'."\n" - ."\n" - .'- rule: A rule-based configuration.', - 'type' => 'string', - 'example' => 'global', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'The version number of the site configuration. For sites with version management enabled, this parameter specifies the site version to which the configuration applies. The default value is 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'The execution order of the rule. Rules with smaller values are executed first.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Specifies whether the rule is enabled. This parameter is not required for global configurations. Valid values:'."\n" - ."\n" - .'- on: The rule is enabled.'."\n" - ."\n" - .'- off: The rule is disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'The content of the rule, which uses a conditional expression to match user requests. This parameter is not required for global configurations. There are two scenarios:'."\n" - ."\n" - .'- To match all incoming requests, set the value to true.'."\n" - ."\n" - .'- To match specific requests, set the value to a custom expression, such as (http.host eq "video.example.com").', - 'type' => 'string', - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'The name of the rule. This parameter is not required for global configurations.', - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74'], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3528160969****'."\n", 'title' => ''], + 'ConfigType' => ['description' => 'The configuration type. Valid values:'."\n" + ."\n" + .'- global: A global configuration.'."\n" + ."\n" + .'- rule: A rule-based configuration.', 'type' => 'string', 'example' => 'global', 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the site configuration. For sites with version management enabled, this parameter specifies the site version to which the configuration applies. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Sequence' => ['description' => 'The execution order of the rule. Rules with smaller values are executed first.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuleEnable' => ['description' => 'Specifies whether the rule is enabled. This parameter is not required for global configurations. Valid values:'."\n" + ."\n" + .'- on: The rule is enabled.'."\n" + ."\n" + .'- off: The rule is disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'The content of the rule, which uses a conditional expression to match user requests. This parameter is not required for global configurations. There are two scenarios:'."\n" + ."\n" + .'- To match all incoming requests, set the value to true.'."\n" + ."\n" + .'- To match specific requests, set the value to a custom expression, such as (http.host eq "video.example.com").', 'type' => 'string', 'example' => '(http.host eq "video.example.com")', 'title' => ''], + 'RuleName' => ['description' => 'The name of the rule. This parameter is not required for global configurations.', 'type' => 'string', 'example' => 'rule_example', 'title' => ''], 'RequestHeaderModification' => [ 'description' => 'The request header modifications. The add, delete, and modify operations are supported.', 'type' => 'array', @@ -41645,40 +23759,20 @@ 'description' => 'The details of the request header modification.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the request header.', - 'type' => 'string', - 'example' => 'headerName', - 'title' => '', - ], - 'Operation' => [ - 'description' => 'The operation to perform. Valid values:'."\n" - ."\n" - .'- add: Adds a header.'."\n" - ."\n" - .'- del: Deletes a header.'."\n" - ."\n" - .'- modify: Modifies a header.', - 'type' => 'string', - 'example' => 'add', - 'title' => '', - ], - 'Value' => [ - 'description' => 'The value of the request header.', - 'type' => 'string', - 'example' => 'headValue', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The type of the value. Valid values:'."\n" - ."\n" - .'- static: A static value.'."\n" - ."\n" - .'- dynamic: A dynamic value.', - 'type' => 'string', - 'example' => 'static', - 'title' => '', - ], + 'Name' => ['description' => 'The name of the request header.', 'type' => 'string', 'example' => 'headerName', 'title' => ''], + 'Operation' => ['description' => 'The operation to perform. Valid values:'."\n" + ."\n" + .'- add: Adds a header.'."\n" + ."\n" + .'- del: Deletes a header.'."\n" + ."\n" + .'- modify: Modifies a header.', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'Value' => ['description' => 'The value of the request header.', 'type' => 'string', 'example' => 'headValue', 'title' => ''], + 'Type' => ['description' => 'The type of the value. Valid values:'."\n" + ."\n" + .'- static: A static value.'."\n" + ."\n" + .'- dynamic: A dynamic value.', 'type' => 'string', 'example' => 'static', 'title' => ''], ], 'title' => '', 'example' => '', @@ -41693,28 +23787,16 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], 'title' => 'Query HTTP Request Header Configuration Details', 'changeSet' => [ - [ - 'createdAt' => '2025-04-10T07:02:39.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-04-10T07:02:39.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetHttpRequestHeaderModificationRule', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHttpRequestHeaderModificationRule'], ], ], 'ramActions' => [ @@ -41725,12 +23807,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -41738,13 +23815,9 @@ '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' => 'Query HTTP Response Header Rules', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the details of an HTTP response header modification rule for a site.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -41757,137 +23830,68 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257653', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can obtain the site ID by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID, which can be obtained by calling the [ListHttpResponseHeaderModificationRules](~~2867483~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID. You can obtain the configuration ID by calling the [ListHttpResponseHeaderModificationRules](~~2867483~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '35281609698****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Request response result.', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', - ], - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '35281609698****', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'Configuration type, with the following values:'."\n" - .'- global: Global configuration.'."\n" - .'- rule: Rule-based configuration.', - 'type' => 'string', - 'example' => 'rule', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'The version number of the site configuration. For sites that have enabled configuration version management, you can use this parameter to specify the effective version of the site configuration, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'Rule execution order. The smaller the value, the higher the priority.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Possible values are:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395'], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '35281609698****', 'title' => ''], + 'ConfigType' => ['description' => 'The configuration type. Valid values:'."\n" + ."\n" + .'- `global`: global configuration.'."\n" + ."\n" + .'- `rule`: rule configuration.', 'type' => 'string', 'example' => 'rule', 'title' => ''], + 'SiteVersion' => ['description' => 'The version of the site configuration. If configuration versioning is enabled for the site, this parameter specifies the version to which this configuration applies. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Sequence' => ['description' => 'The rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuleEnable' => ['description' => 'The rule switch. This parameter applies only to rule configurations. Valid values:'."\n" + ."\n" + .'- `on`: The rule is enabled.'."\n" + ."\n" + .'- `off`: The rule is disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'The rule content, a conditional expression used to match user requests. This parameter applies only to rule configurations. The expression can be:'."\n" + ."\n" + .'- `true`: Matches all incoming requests.'."\n" + ."\n" + .'- A custom expression, such as `(http.host eq "video.example.com")`: Matches specific requests.', 'type' => 'string', 'example' => '(http.host eq "video.example.com")', 'title' => ''], + 'RuleName' => ['description' => 'The rule name. This parameter applies only to rule configurations.', 'type' => 'string', 'example' => 'rule_example', 'title' => ''], 'ResponseHeaderModification' => [ - 'description' => 'Modify response headers, supporting add, delete, and modify operations.', + 'description' => 'A list of modifications to apply to the response header.', 'type' => 'array', 'items' => [ - 'description' => 'Details of modifying response headers.', + 'description' => 'The details of a single response header modification.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'Response header name.', - 'type' => 'string', - 'example' => 'headerName', - 'title' => '', - ], - 'Operation' => [ - 'description' => 'Operation method. Possible values are:'."\n" - ."\n" - .'- add: Add.'."\n" - .'- del: Delete'."\n" - .'- modify: Modify.', - 'type' => 'string', - 'example' => 'add', - 'title' => '', - ], - 'Value' => [ - 'description' => 'Response header value.', - 'type' => 'string', - 'example' => 'headerValue', - 'title' => '', - ], - 'Type' => [ - 'description' => 'Value Type. Valid values:'."\n" - .'- static: Static pattern.'."\n" - .'- dynamic: Dynamic pattern.', - 'type' => 'string', - 'example' => 'static', - 'title' => '', - ], + 'Name' => ['description' => 'The response header name.', 'type' => 'string', 'example' => 'headerName', 'title' => ''], + 'Operation' => ['description' => 'The operation. Valid values:'."\n" + ."\n" + .'- `add`: Adds a header.'."\n" + ."\n" + .'- `del`: Deletes a header.'."\n" + ."\n" + .'- `modify`: Modifies a header.', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'Value' => ['description' => 'The response header value.', 'type' => 'string', 'example' => 'headerValue', 'title' => ''], + 'Type' => ['description' => 'The value type. Valid values:'."\n" + ."\n" + .'- `static`: static mode.'."\n" + ."\n" + .'- `dynamic`: dynamic mode.', 'type' => 'string', 'example' => 'static', 'title' => ''], ], 'title' => '', 'example' => '', @@ -41902,28 +23906,16 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], 'title' => 'Query HTTP Response Header Configuration Details', 'changeSet' => [ - [ - 'createdAt' => '2025-04-10T07:02:38.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-04-10T07:02:38.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetHttpResponseHeaderModificationRule', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHttpResponseHeaderModificationRule'], ], ], 'ramActions' => [ @@ -41934,12 +23926,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -41947,12 +23934,8 @@ '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', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -41965,242 +23948,123 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257600', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can obtain this ID by calling the [ListSites](~~ListSites~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'ConfigId of the configuration, which can be obtained by calling the [listHttpsApplicationConfigurations](~~2869087~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '352816096987136', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID. You can obtain this ID by calling the [listHttpsApplicationConfigurations](~~2869087~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '352816096987136', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'A3790430-3A06-535F-A424-0998BD9A6C9F', - ], - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '352816096987136', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'Configuration type, which can be used to query global or rule configurations. Possible values:'."\n" - ."\n" - .'- global: Query global configuration.'."\n" - .'- rule: Query rule configuration.', - 'type' => 'string', - 'example' => 'global', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'Version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the version of the site for which the configuration takes effect. The default is version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'Rule execution order. The smaller the value, the higher the priority.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Rule switch. This parameter does not need to be set when adding a global configuration. Possible values:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter does not need to be set when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true.'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq "video.example.com")', - 'type' => 'string', - 'example' => '(http.host eq \\"video.example.com\\")', - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'Rule name. This parameter does not need to be set when adding a global configuration.', - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], - 'HttpsForce' => [ - 'description' => 'Whether to enable forced HTTPS. Default is disabled. Possible values:'."\n" - ."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'HttpsForceCode' => [ - 'description' => 'Status code for forced HTTPS redirection. Possible values:'."\n" - ."\n" - .'- 301'."\n" - .'- 302'."\n" - .'- 307'."\n" - .'- 308', - 'type' => 'string', - 'example' => '301', - 'title' => '', - ], - 'AltSvc' => [ - 'description' => 'Alt-Svc feature switch. Default is disabled. Possible values:'."\n" - ."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'AltSvcClear' => [ - 'description' => 'Whether the Alt-Svc header includes the clear parameter. Default is disabled. Possible values:'."\n" - ."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'AltSvcPersist' => [ - 'description' => 'Whether the Alt-Svc header includes the persist parameter. Default is disabled. Possible values:'."\n" - ."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'AltSvcMa' => [ - 'description' => 'Alt-Svc validity period in seconds. The default is 86400 seconds.', - 'type' => 'string', - 'example' => '86400', - 'title' => '', - ], - 'Hsts' => [ - 'description' => 'Whether to enable HSTS. Default is disabled. Possible values:'."\n" - ."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'HstsMaxAge' => [ - 'description' => 'HSTS expiration time in seconds.', - 'type' => 'string', - 'example' => '3600', - 'title' => '', - ], - 'HstsIncludeSubdomains' => [ - 'description' => 'Whether to include subdomains in HSTS, default is off. Value range:'."\n" - .'- on: enabled. '."\n" - .'- off: disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'HstsPreload' => [ - 'description' => 'Whether to enable HSTS preload, default is off. Value range:'."\n" - ."\n" - .'- on: enabled.'."\n" - .'- off: disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'HttpsSniVerify' => [ - 'description' => 'Specifies whether SNI validation is enabled. Disabled by default. Valid values:'."\n" - ."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'HttpsNoSniDeny' => [ - 'description' => 'Whether to deny TLS handshake requests without SNI. Disabled by default. Valid values: '."\n" - .'- on: Enabled. '."\n" - .'- off: Disabled. ', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'HttpsSniWhitelist' => [ - 'description' => 'The whitelist of allowed SNI entries. Separate multiple entries with spaces. ', - 'type' => 'string', - 'example' => 'abc edf', - 'title' => '', - ], - ], - 'example' => '', - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A3790430-3A06-535F-A424-0998BD9A6C9F'], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '352816096987136', 'title' => ''], + 'ConfigType' => ['description' => 'The configuration type. You can query for a global or rule configuration based on this parameter. Valid values:'."\n" + ."\n" + .'- `global`: a global configuration.'."\n" + ."\n" + .'- `rule`: a rule configuration.', 'type' => 'string', 'example' => 'global', 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the site configuration. For sites with configuration versioning enabled, this parameter specifies the applicable site version. The default is version `0`.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Sequence' => ['description' => 'The rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuleEnable' => ['description' => 'Specifies whether to enable the rule. This parameter is not required for a global configuration. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'The conditional expression used to match user requests. This parameter is not required for a global configuration. There are two scenarios:'."\n" + ."\n" + .'- To match all incoming requests, set the value to `true`.'."\n" + ."\n" + .'- To match specific requests, set the value to a custom expression, such as `(http.host eq "video.example.com")`.', 'type' => 'string', 'example' => '(http.host eq \\"video.example.com\\")', 'title' => ''], + 'RuleName' => ['description' => 'The rule name. This parameter is not required for a global configuration.', 'type' => 'string', 'example' => 'rule_example', 'title' => ''], + 'HttpsForce' => ['description' => 'Specifies whether to enable force HTTPS, which is disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'HttpsForceCode' => ['description' => 'The status code for the force HTTPS redirect. Valid values:'."\n" + ."\n" + .'- `301`'."\n" + ."\n" + .'- `302`'."\n" + ."\n" + .'- `307`'."\n" + ."\n" + .'- `308`', 'type' => 'string', 'example' => '301', 'title' => ''], + 'AltSvc' => ['description' => 'Specifies whether to enable the Alt-Svc feature, which is disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'AltSvcClear' => ['description' => 'Specifies whether to include the `clear` parameter in the Alt-Svc header, which is disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'AltSvcPersist' => ['description' => 'Specifies whether to include the `persist` parameter in the Alt-Svc header, which is disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'AltSvcMa' => ['description' => 'The Alt-Svc max-age, in seconds. Default: `86400`.', 'type' => 'string', 'example' => '86400', 'title' => ''], + 'Hsts' => ['description' => 'Specifies whether to enable HSTS, which is disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'HstsMaxAge' => ['description' => 'The value of the `max-age` directive for HSTS, in seconds.', 'type' => 'string', 'example' => '3600', 'title' => ''], + 'HstsIncludeSubdomains' => ['description' => 'Specifies whether to include subdomains in the HSTS policy, which is disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'HstsPreload' => ['description' => 'Specifies whether to enable HSTS preload, which is disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'HttpsSniVerify' => ['description' => 'Specifies whether to enable SNI verification, which is disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'HttpsNoSniDeny' => ['description' => 'Specifies whether to deny TLS handshakes that lack an SNI, which is disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'HttpsSniWhitelist' => ['description' => 'The SNI allowlist. Separate multiple values with a space.', 'type' => 'string', 'example' => 'abc edf', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query Site HTTPS Application Configuration', - 'summary' => 'Query a Single HTTPS Application Configuration', + 'summary' => 'Retrieves a single HTTPS application configuration.', 'changeSet' => [ - [ - 'createdAt' => '2025-06-03T07:09:13.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-06-03T07:09:13.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetHttpsApplicationConfiguration', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHttpsApplicationConfiguration'], ], ], 'ramActions' => [ @@ -42211,12 +24075,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -42225,12 +24084,8 @@ ], 'GetHttpsBasicConfiguration' => [ 'summary' => 'Query a Single HTTPS Basic Configuration', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -42242,34 +24097,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257602', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'ConfigId of the configuration, which can be obtained by calling the [ListHttpsBasicConfigurations](~~2867470~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '352816096987136', - 'title' => '', - ], + 'schema' => ['description' => 'ConfigId of the configuration, which can be obtained by calling the [ListHttpsBasicConfigurations](~~2867470~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '352816096987136', 'title' => ''], ], ], 'responses' => [ @@ -42279,166 +24118,68 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D2***', - ], - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '352816096987136', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'Configuration type, which can be used to query global or rule configurations. Value range:'."\n" - .'- global: Query global configuration;'."\n" - .'- rule: Query rule configuration;', - 'type' => 'string', - 'example' => 'global', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'Rule execution sequence.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Rule switch. Value range:'."\n" - ."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'Matching rule content.', - 'type' => 'string', - 'example' => '(http.host eq \\"video.example.com\\")'."\n", - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'Rule name.', - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], - 'Https' => [ - 'description' => 'Whether to enable HTTPS, default is enabled. Value range:'."\n" - ."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Tls10' => [ - 'description' => 'Whether to enable TLS1.0, default is disabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Tls11' => [ - 'description' => 'Whether to enable TLS1.1, default is disabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Tls12' => [ - 'description' => 'Whether to enable TLS1.2, default is disabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Tls13' => [ - 'description' => 'Whether to enable TLS1.3, default is disabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'CiphersuiteGroup' => [ - 'description' => 'Cipher suite group, default is all cipher suites. Value range:'."\n" - ."\n" - .'- all: All cipher suites.'."\n" - .'- strict: Strong cipher suites.'."\n" - .'- custom: Custom cipher suites.', - 'type' => 'string', - 'example' => 'all', - 'title' => '', - ], - 'Ciphersuite' => [ - 'description' => 'Custom cipher suite, indicating the specific encryption algorithm selected when CiphersuiteGroup is set to custom.', - 'type' => 'string', - 'example' => 'TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256', - 'title' => '', - ], - 'OcspStapling' => [ - 'description' => 'Whether to enable OCSP, default is disabled. Value range:'."\n" - ."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Http2' => [ - 'description' => 'Whether to enable HTTP2, default is enabled. Value range:'."\n" - ."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Http3' => [ - 'description' => 'Whether to enable HTTP3, which is enabled by default. The value can be:'."\n" - .'- on: Enabled. '."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - ], - 'example' => '', - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D2***'], + 'ConfigId' => ['description' => 'Configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '352816096987136', 'title' => ''], + 'ConfigType' => ['description' => 'Configuration type, which can be used to query global or rule configurations. Value range:'."\n" + .'- global: Query global configuration;'."\n" + .'- rule: Query rule configuration;', 'type' => 'string', 'example' => 'global', 'title' => ''], + 'Sequence' => ['description' => 'Rule execution sequence.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuleEnable' => ['description' => 'Rule switch. Value range:'."\n" + ."\n" + .'- on: Enable.'."\n" + .'- off: Disable.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'Matching rule content.', 'type' => 'string', 'example' => '(http.host eq \\"video.example.com\\")'."\n", 'title' => ''], + 'RuleName' => ['description' => 'Rule name.', 'type' => 'string', 'example' => 'rule_example', 'title' => ''], + 'Https' => ['description' => 'Whether to enable HTTPS, default is enabled. Value range:'."\n" + ."\n" + .'- on: Enable.'."\n" + .'- off: Disable.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Tls10' => ['description' => 'Whether to enable TLS1.0, default is disabled. Value range:'."\n" + .'- on: Enable.'."\n" + .'- off: Disable.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Tls11' => ['description' => 'Whether to enable TLS1.1, default is disabled. Value range:'."\n" + .'- on: Enable.'."\n" + .'- off: Disable.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Tls12' => ['description' => 'Whether to enable TLS1.2, default is disabled. Value range:'."\n" + .'- on: Enable.'."\n" + .'- off: Disable.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Tls13' => ['description' => 'Whether to enable TLS1.3, default is disabled. Value range:'."\n" + .'- on: Enable.'."\n" + .'- off: Disable.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'CiphersuiteGroup' => ['description' => 'Cipher suite group, default is all cipher suites. Value range:'."\n" + ."\n" + .'- all: All cipher suites.'."\n" + .'- strict: Strong cipher suites.'."\n" + .'- custom: Custom cipher suites.', 'type' => 'string', 'example' => 'all', 'title' => ''], + 'Ciphersuite' => ['description' => 'Custom cipher suite, indicating the specific encryption algorithm selected when CiphersuiteGroup is set to custom.', 'type' => 'string', 'example' => 'TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256', 'title' => ''], + 'OcspStapling' => ['description' => 'Whether to enable OCSP, default is disabled. Value range:'."\n" + ."\n" + .'- on: Enable.'."\n" + .'- off: Disable.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Http2' => ['description' => 'Whether to enable HTTP2, default is enabled. Value range:'."\n" + ."\n" + .'- on: Enable.'."\n" + .'- off: Disable.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Http3' => ['description' => 'Whether to enable HTTP3, which is enabled by default. The value can be:'."\n" + .'- on: Enabled. '."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'Query Site HTTPS Basic Configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetHttpsBasicConfiguration', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHttpsBasicConfiguration'], ], ], 'ramActions' => [ @@ -42449,12 +24190,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -42462,13 +24198,9 @@ 'operationType' => 'read', ], 'GetIPv6' => [ - 'summary' => 'Query Site IPv6 Configuration', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the IPv6 configuration for a site.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -42481,59 +24213,41 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257435', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the site. To obtain this ID, call the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792'], 'Enable' => [ - 'description' => 'Indicates whether IPv6 is enabled. Valid values:'."\n" + 'description' => 'Specifies whether IPv6 is enabled. Valid values:'."\n" ."\n" - .'* **on**'."\n" - .'* **off**'."\n", + .'- **on**: Enabled.'."\n" + ."\n" + .'- **off**: Disabled.', + 'enumValueTitles' => ['off' => 'off', 'on' => 'on'], 'type' => 'string', 'example' => 'on', - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], 'title' => '', ], 'Region' => [ - 'enumValueTitles' => [ - 'x.x' => 'x.x', - 'cn.cn' => 'cn.cn', - ], - 'description' => 'Area where IPv6 is enabled. Default value: x.x.'."\n" + 'description' => 'The region where IPv6 is enabled. The default value is `x.x`. Valid values:'."\n" ."\n" - .'- x.x: Global.'."\n" - .'- cn.cn: Mainland China.', + .'- `x.x`: Global.'."\n" + ."\n" + .'- `cn.cn`: Chinese mainland.', + 'enumValueTitles' => ['x.x' => 'x.x', 'cn.cn' => 'cn.cn'], 'type' => 'string', 'example' => 'x.x', 'title' => '', @@ -42545,28 +24259,16 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], 'title' => 'Query Site IPv6 Configuration', 'changeSet' => [ - [ - 'createdAt' => '2025-03-27T02:33:21.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-03-27T02:33:21.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetIPv6', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIPv6'], ], ], 'ramActions' => [ @@ -42577,12 +24279,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -42590,138 +24287,173 @@ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"156A6B-677B1A-4297B7-9187B7-2B44792\\",\\n \\"Enable\\": \\"on\\",\\n \\"Region\\": \\"x.x\\"\\n}","type":"json"}]', ], 'GetImageTransform' => [ - 'summary' => 'Query Single Site Image Transformation Configuration', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries a single site image transformation configuration.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257356', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID. It can be obtained by calling the [ListImageTransforms](~~2869056~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '352816096987136', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID. You can call the [ListImageTransforms](~~2869056~~) operation to obtain the configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '352816096987136', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', - ], - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '352816096987136', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE'], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '352816096987136', 'title' => ''], 'ConfigType' => [ - 'description' => 'Configuration type. Possible values:'."\n" - .'- global: Global configuration;'."\n" - .'- rule: Rule-based configuration;', + 'description' => 'The configuration type. Valid values:'."\n" + .'- global: global configuration.'."\n" + .'- rule: rule configuration.', + 'enumValueTitles' => ['rule' => 'Rule configuration.', 'global' => 'Global configuration.'], 'type' => 'string', - 'enumValueTitles' => [ - 'rule' => 'rule', - 'global' => 'global', - ], 'example' => 'global', 'title' => '', ], - 'SiteVersion' => [ - 'description' => 'The version number of the site configuration. For sites with version management enabled, this parameter can specify the effective version of the site, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'Rule execution order. The smaller the value, the higher the priority.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - 'title' => '', - ], + 'SiteVersion' => ['description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. The default value is version 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Sequence' => ['description' => 'The rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'Enable' => [ - 'description' => 'Whether to enable image transformation. Possible values:'."\n" + 'description' => 'Specifies whether to enable image transformation. Valid values:'."\n" .'- on: Enabled.'."\n" .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], 'example' => 'on', 'title' => '', ], 'RuleEnable' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Possible values:'."\n" + 'description' => 'The rule switch. This parameter does not need to be set when you add a global configuration. Valid values:'."\n" .'- on: Enabled.'."\n" .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], 'example' => 'on', 'title' => '', ], - 'Rule' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'example' => '(http.request.uri.path.file_name eq \\"jpg\\")', - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'Rule name. This parameter does not need to be set when adding global configuration.', - 'type' => 'string', - 'example' => 'test', + 'Rule' => ['description' => 'The rule content, which uses a conditional expression to match user requests. This parameter does not need to be set when you add a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + .'- Match specified requests: Set the value to a custom expression, such as (http.host eq \\"video.example.com\\").', 'type' => 'string', 'example' => '(http.request.uri.path.file_name eq \\"jpg\\")', 'title' => ''], + 'RuleName' => ['description' => 'The rule name. This parameter does not need to be set when you add a global configuration.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'AutoWebp' => ['title' => '', 'description' => 'Specifies whether to enable adaptive WebP. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on'], + 'AutoAvif' => ['title' => '', 'description' => 'Specifies whether to enable adaptive AVIF. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on'], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + '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 \\"AutoWebp\\": \\"on\\",\\n \\"AutoAvif\\": \\"on\\"\\n}","type":"json"}]', + 'title' => 'Query a single site image transformation configuration', + '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}'], + ], + ], + ], + ], + ], + 'GetKeylessServer' => [ + 'summary' => 'Retrieves the configuration of a Keyless server.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239130', + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5407498413****', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'Keyless server ID。', 'type' => 'string', 'required' => true, 'example' => 'baba39055622c008b90285a8838e****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456****', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'Id' => ['description' => 'Keyless server ID。', 'type' => 'string', 'example' => 'baba39055622c008b90285a8838e****', 'title' => ''], + 'Name' => ['description' => 'The Keyless server name.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'Host' => ['description' => 'The Keyless server hostname.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'Port' => ['description' => 'The Keyless server port. Valid values: **1** to **65535**.', 'type' => 'integer', 'format' => 'int64', 'example' => '443', 'title' => ''], + 'Verify' => [ + 'description' => 'Indicates whether to verify the Keyless server certificate. Default value: false.', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', 'title' => '', ], + 'CaCertificate' => ['description' => 'The CA certificate used to verify the Keyless server certificate. This parameter takes effect only when Verify is set to true.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----****', 'title' => ''], + 'ClientCertificate' => ['description' => 'The client certificate. This parameter must be used together with the client private key.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----****', 'title' => ''], + 'ClientPrivateKey' => ['description' => 'The client private key. This parameter must be used together with the client certificate.', 'type' => 'string', 'example' => '-----BEGIN RSA PRIVATE KEY-----****', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time. The time follows the format YYYY-MM-DDTHH:MM:SS+08:00 in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2025-07-18T20:33:31+08:00', 'title' => ''], + 'UpdateTime' => ['description' => 'The modification time. The time follows the format YYYY-MM-DDTHH:MM:SS+08:00 in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2025-07-18T20:33:31+08:00', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3558df77-8a7a-4060-a900-2d794940****', 'title' => ''], ], 'example' => '', ], @@ -42729,105 +24461,76 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Id.MissingParameter', 'errorMessage' => 'The parameter Id is required.', 'description' => 'The required parameter Id is missing.'], + ], + 403 => [ + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], + ], + [ + ['errorCode' => 'Certificate.NotFound', 'errorMessage' => 'The specified certificate does not exist.', 'description' => 'The specified certificate does not exist.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], - '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"}]', - 'title' => 'Query Single Site Image Transformation Configuration', + 'title' => 'Get keyless server configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetImageTransform', - ], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetKeylessServer'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ - 'action' => 'esa:GetImageTransform', + 'action' => 'esa:GetKeylessServer', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'operationType' => 'read', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 0,\\n \\"SiteName\\": \\"example.com\\",\\n \\"Id\\": \\"baba39055622c008b90285a8838e****\\",\\n \\"Name\\": \\"example\\",\\n \\"Host\\": \\"example.com\\",\\n \\"Port\\": 443,\\n \\"Verify\\": true,\\n \\"CaCertificate\\": \\"-----BEGIN CERTIFICATE-----****\\",\\n \\"ClientCertificate\\": \\"-----BEGIN CERTIFICATE-----****\\",\\n \\"ClientPrivateKey\\": \\"-----BEGIN RSA PRIVATE KEY-----****\\",\\n \\"CreateTime\\": \\"2025-07-18T20:33:31+08:00\\",\\n \\"UpdateTime\\": \\"2025-07-18T20:33:31+08:00\\",\\n \\"RequestId\\": \\"3558df77-8a7a-4060-a900-2d794940****\\"\\n}","type":"json"}]', ], 'GetKv' => [ - 'summary' => 'Queries the value of a key in a key-value pair.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239214', - 'abilityTreeNodes' => [ - 'FEATUREdcdnGMYWU5', - ], + 'abilityTreeNodes' => ['FEATUREdcdnGMYWU5'], ], 'parameters' => [ [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace that you specify when you call the [CreateKvNamespace](~~2850317~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_namespace', - 'title' => '', - ], + 'schema' => ['description' => 'The name specified when you call the [CreateKvNamespace](~~2850317~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'test_namespace', 'title' => ''], ], [ 'name' => 'Key', 'in' => 'query', - 'schema' => [ - 'description' => 'The key name for the query.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_key', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the key to query.', 'type' => 'string', 'required' => true, 'example' => 'test_key', 'title' => ''], ], [ 'name' => 'Base64', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to decode the value by using Base 64. If you call the [PutKv](~~2850482~~) operation and set the Base64 parameter to true, set this parameter to true to read the original content.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to Base64-decode the value. If you set the base64 parameter to true when you called the [PutKv](~~2850482~~) operation, set this parameter to true to read the original content.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ @@ -42835,18 +24538,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Value' => [ - 'description' => 'The value of the key.'."\n", - 'type' => 'string', - 'example' => 'test_value', - 'title' => '', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', - 'title' => '', - ], + 'Value' => ['description' => 'The value of the key.', 'type' => 'string', 'example' => 'test_value', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', 'title' => ''], ], 'description' => '', 'title' => '', @@ -42856,120 +24549,42 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidAccount.Malformed', - 'errorMessage' => 'The specified account is invalid.', - 'description' => 'The account number is not entered correctly, for example, the input is empty.', - ], - [ - 'errorCode' => 'InvalidNameSpace.Malformed', - 'errorMessage' => 'The specified namespace is invalid.', - 'description' => 'The bucket name is entered incorrectly, such as an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.Malformed', - 'errorMessage' => 'The specified key is invalid.', - 'description' => 'Key name input error, such as entering an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.ExceedsMaximum', - 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', - 'description' => 'The length of the requested key is too large.', - ], - [ - 'errorCode' => 'InvalidValue.ExceedsMaximum', - 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', - 'description' => 'The value deposited is too large.', - ], - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The specified parameters are invalid.', - 'description' => 'Parameter is illegal.', - ], + ['errorCode' => 'InvalidAccount.Malformed', 'errorMessage' => 'The specified account is invalid.', 'description' => 'The account number is not entered correctly, for example, the input is empty.'], + ['errorCode' => 'InvalidNameSpace.Malformed', 'errorMessage' => 'The specified namespace is invalid.', 'description' => 'The bucket name is entered incorrectly, such as an empty string.'], + ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified key is invalid.', 'description' => 'Key name input error, such as entering an empty string.'], + ['errorCode' => 'InvalidKey.ExceedsMaximum', 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', 'description' => 'The length of the requested key is too large.'], + ['errorCode' => 'InvalidValue.ExceedsMaximum', 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', 'description' => 'The value deposited is too large.'], + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The specified parameters are invalid.', 'description' => 'Parameter is illegal.'], ], 403 => [ - [ - 'errorCode' => 'InvalidKey.ExceedsCapacity', - 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', - 'description' => 'The capacity of the storage space exceeds the limit.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidParameters', - 'errorMessage' => 'The specified authentication parameters are invalid.', - 'description' => 'Authentication parameter input error.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'InvalidKey.ExceedsCapacity', 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', 'description' => 'The capacity of the storage space exceeds the limit.'], + ['errorCode' => 'Unauthorized.InvalidParameters', 'errorMessage' => 'The specified authentication parameters are invalid.', 'description' => 'Authentication parameter input error.'], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'InvalidAccount.NotFound', - 'errorMessage' => 'The specified account does not exist.', - 'description' => 'The specified account does not exist.', - ], - [ - 'errorCode' => 'InvalidNameSpace.NotFound', - 'errorMessage' => 'The specified namespace does not exist.', - 'description' => '', - ], - [ - 'errorCode' => 'InvalidKey.NotFound', - 'errorMessage' => 'The specified key does not exist.', - 'description' => 'The specified key-value pair does not exist.', - ], + ['errorCode' => 'InvalidAccount.NotFound', 'errorMessage' => 'The specified account does not exist.', 'description' => 'The specified account does not exist.'], + ['errorCode' => 'InvalidNameSpace.NotFound', 'errorMessage' => 'The specified namespace does not exist.', 'description' => ''], + ['errorCode' => 'InvalidKey.NotFound', 'errorMessage' => 'The specified key does not exist.', 'description' => 'The specified key-value pair does not exist.'], ], 406 => [ - [ - 'errorCode' => 'InvalidNameSpace.Duplicate', - 'errorMessage' => 'The specified namespace already exists.', - 'description' => 'Specified storage space', - ], - [ - 'errorCode' => 'InvalidNameSpace.QuotaFull', - 'errorMessage' => 'The maximum number of namespaces is exceeded.', - 'description' => 'The number of storage spaces exceeds the capacity limit.', - ], + ['errorCode' => 'InvalidNameSpace.Duplicate', 'errorMessage' => 'The specified namespace already exists.', 'description' => 'Specified storage space'], + ['errorCode' => 'InvalidNameSpace.QuotaFull', 'errorMessage' => 'The maximum number of namespaces is exceeded.', 'description' => 'The number of storage spaces exceeds the capacity limit.'], ], 429 => [ - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests are submitted.', - 'description' => 'Submissions are too frequent, please try again later', - ], - [ - 'errorCode' => 'TooQuickRequests', - 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', - 'description' => 'The modification or deletion of key-value pairs is too frequent.', - ], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests are submitted.', 'description' => 'Submissions are too frequent, please try again later'], + ['errorCode' => 'TooQuickRequests', 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', 'description' => 'The modification or deletion of key-value pairs is too frequent.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Value\\": \\"test_value\\",\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetKv', + 'summary' => 'Retrieves the value of a specified key.', 'changeSet' => [ - [ - 'createdAt' => '2024-11-26T03:43:35.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-11-26T03:43:35.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '50', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetKv', - ], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetKv'], ], ], 'ramActions' => [ @@ -42980,26 +24595,17 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'operationType' => 'read', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Value\\": \\"test_value\\",\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\"\\n}","type":"json"}]', ], 'GetKvAccount' => [ - 'summary' => 'Queries the Edge KV usage in your Alibaba Cloud account, including the information about all namespaces.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Retrieves usage information for an account in the KV service, including a list of all namespaces.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -43012,9 +24618,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239142', - 'abilityTreeNodes' => [ - 'FEATUREdcdnGMYWU5', - ], + 'abilityTreeNodes' => ['FEATUREdcdnGMYWU5'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [], @@ -43023,122 +24627,40 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether Edge KV is activated for the Alibaba Cloud account.'."\n" - ."\n" - .'* **online**'."\n" - .'* **offline**'."\n", - 'type' => 'string', - 'example' => 'online', - 'title' => '', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', - 'title' => '', - ], - 'NamespaceUsed' => [ - 'description' => 'The number of created namespaces that store key-value data in the account.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'NamespaceQuota' => [ - 'description' => 'The maximum number of namespaces that can be created in the account.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'CapacityString' => [ - 'description' => 'The available capacity of all namespaces in the account.'."\n", - 'type' => 'string', - 'example' => '1 GB', - 'title' => '', - ], - 'CapacityUsedString' => [ - 'description' => 'The used capacity of all namespaces in the account.'."\n", - 'type' => 'string', - 'example' => '100 MB', - 'title' => '', - ], - 'Capacity' => [ - 'description' => 'The available capacity of all namespaces in the account. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1073741824', - 'title' => '', - ], - 'CapacityUsed' => [ - 'description' => 'The used capacity of all namespaces in the account. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10048576', - 'title' => '', - ], + 'Status' => ['description' => 'The status of the account.'."\n" + ."\n" + .'- **online**: The account is active.'."\n" + ."\n" + .'- **offline**: The account is shut down.', 'type' => 'string', 'example' => 'online', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', 'title' => ''], + 'NamespaceUsed' => ['description' => 'The number of namespaces created for the account.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'NamespaceQuota' => ['description' => 'The quota on the number of KV storage spaces that you can request for the account.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'CapacityString' => ['description' => 'The total available capacity of all namespaces for the account.', 'type' => 'string', 'example' => '1 GB', 'title' => ''], + 'CapacityUsedString' => ['description' => 'The total used capacity of all namespaces for the account.', 'type' => 'string', 'example' => '100 MB', 'title' => ''], + 'Capacity' => ['description' => 'The total available capacity of all namespaces for the account, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1073741824', 'title' => ''], + 'CapacityUsed' => ['description' => 'The total used capacity of all namespaces for the account, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '10048576', 'title' => ''], 'NamespaceList' => [ - 'description' => 'The namespaces in the account.'."\n", + 'description' => 'The list of namespaces for the account.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the namespace. Valid values:'."\n" - ."\n" - .'* **online**: normal.'."\n" - .'* **delete**: pending deletion.'."\n" - .'* **deleting**: being deleted.'."\n" - .'* **deleted**: deleted.'."\n", - 'type' => 'string', - 'example' => 'online', - 'title' => '', - ], - 'Namespace' => [ - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'example' => 'test_namespace', - 'title' => '', - ], - 'NamespaceId' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'example' => '643355322374688768', - 'title' => '', - ], - 'Description' => [ - 'description' => 'The description of the namespace.'."\n", - 'type' => 'string', - 'example' => 'the first namespace', - 'title' => '', - ], - 'Capacity' => [ - 'description' => 'The available capacity of the namespace. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1073741824', - 'title' => '', - ], - 'CapacityUsed' => [ - 'description' => 'The used capacity of the namespace. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100048576', - 'title' => '', - ], - 'CapacityString' => [ - 'description' => 'The available capacity of the namespace.'."\n", - 'type' => 'string', - 'example' => '1 GB', - 'title' => '', - ], - 'CapacityUsedString' => [ - 'description' => 'The used capacity of the namespace.'."\n", - 'type' => 'string', - 'example' => '100 MB', - 'title' => '', - ], + 'Status' => ['description' => 'The status of the namespace. Valid values:'."\n" + ."\n" + .'- **online**: Normal.'."\n" + ."\n" + .'- **delete**: Pending deletion.'."\n" + ."\n" + .'- **deleting**: Being deleted.'."\n" + ."\n" + .'- **deleted**: Deleted.', 'type' => 'string', 'example' => 'online', 'title' => ''], + 'Namespace' => ['description' => 'The name of the namespace.', 'type' => 'string', 'example' => 'test_namespace', 'title' => ''], + 'NamespaceId' => ['description' => 'The ID of the namespace.', 'type' => 'string', 'example' => '643355322374688768', 'title' => ''], + 'Description' => ['description' => 'The description of the namespace.', 'type' => 'string', 'example' => 'the first namespace', 'title' => ''], + 'Capacity' => ['description' => 'The available capacity of the namespace, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1073741824', 'title' => ''], + 'CapacityUsed' => ['description' => 'The used capacity of the namespace, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '100048576', 'title' => ''], + 'CapacityString' => ['description' => 'The available capacity of the namespace.', 'type' => 'string', 'example' => '1 GB', 'title' => ''], + 'CapacityUsedString' => ['description' => 'The used capacity of the namespace.', 'type' => 'string', 'example' => '100 MB', 'title' => ''], ], 'description' => '', 'title' => '', @@ -43156,110 +24678,38 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidAccount.Malformed', - 'errorMessage' => 'The specified account is invalid.', - 'description' => 'The account number is not entered correctly, for example, the input is empty.', - ], - [ - 'errorCode' => 'InvalidNameSpace.Malformed', - 'errorMessage' => 'The specified namespace is invalid.', - 'description' => 'The bucket name is entered incorrectly, such as an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.Malformed', - 'errorMessage' => 'The specified key is invalid.', - 'description' => 'Key name input error, such as entering an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.ExceedsMaximum', - 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', - 'description' => 'The length of the requested key is too large.', - ], - [ - 'errorCode' => 'InvalidValue.ExceedsMaximum', - 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', - 'description' => 'The value deposited is too large.', - ], + ['errorCode' => 'InvalidAccount.Malformed', 'errorMessage' => 'The specified account is invalid.', 'description' => 'The account number is not entered correctly, for example, the input is empty.'], + ['errorCode' => 'InvalidNameSpace.Malformed', 'errorMessage' => 'The specified namespace is invalid.', 'description' => 'The bucket name is entered incorrectly, such as an empty string.'], + ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified key is invalid.', 'description' => 'Key name input error, such as entering an empty string.'], + ['errorCode' => 'InvalidKey.ExceedsMaximum', 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', 'description' => 'The length of the requested key is too large.'], + ['errorCode' => 'InvalidValue.ExceedsMaximum', 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', 'description' => 'The value deposited is too large.'], ], 403 => [ - [ - 'errorCode' => 'InvalidKey.ExceedsCapacity', - 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', - 'description' => 'The capacity of the storage space exceeds the limit.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidParameters', - 'errorMessage' => 'The specified authentication parameters are invalid.', - 'description' => 'Authentication parameter input error.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'InvalidKey.ExceedsCapacity', 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', 'description' => 'The capacity of the storage space exceeds the limit.'], + ['errorCode' => 'Unauthorized.InvalidParameters', 'errorMessage' => 'The specified authentication parameters are invalid.', 'description' => 'Authentication parameter input error.'], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'InvalidAccount.NotFound', - 'errorMessage' => 'The specified account does not exist.', - 'description' => 'The specified account does not exist.', - ], - [ - 'errorCode' => 'InvalidNameSpace.NotFound', - 'errorMessage' => 'The specified namespace does not exist.', - 'description' => '', - ], - [ - 'errorCode' => 'InvalidKey.NotFound', - 'errorMessage' => 'The specified key does not exist.', - 'description' => 'The specified key-value pair does not exist.', - ], + ['errorCode' => 'InvalidAccount.NotFound', 'errorMessage' => 'The specified account does not exist.', 'description' => 'The specified account does not exist.'], + ['errorCode' => 'InvalidNameSpace.NotFound', 'errorMessage' => 'The specified namespace does not exist.', 'description' => ''], + ['errorCode' => 'InvalidKey.NotFound', 'errorMessage' => 'The specified key does not exist.', 'description' => 'The specified key-value pair does not exist.'], ], 406 => [ - [ - 'errorCode' => 'InvalidNameSpace.Duplicate', - 'errorMessage' => 'The specified namespace already exists.', - 'description' => 'Specified storage space', - ], - [ - 'errorCode' => 'InvalidNameSpace.QuotaFull', - 'errorMessage' => 'The maximum number of namespaces is exceeded.', - 'description' => 'The number of storage spaces exceeds the capacity limit.', - ], + ['errorCode' => 'InvalidNameSpace.Duplicate', 'errorMessage' => 'The specified namespace already exists.', 'description' => 'Specified storage space'], + ['errorCode' => 'InvalidNameSpace.QuotaFull', 'errorMessage' => 'The maximum number of namespaces is exceeded.', 'description' => 'The number of storage spaces exceeds the capacity limit.'], ], 429 => [ - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests are submitted.', - 'description' => 'Submissions are too frequent, please try again later', - ], - [ - 'errorCode' => 'TooQuickRequests', - 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', - 'description' => 'The modification or deletion of key-value pairs is too frequent.', - ], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests are submitted.', 'description' => 'Submissions are too frequent, please try again later'], + ['errorCode' => 'TooQuickRequests', 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', 'description' => 'The modification or deletion of key-value pairs is too frequent.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetKvAccount', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '5', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetKvAccount', - ], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetKvAccount'], ], ], 'ramActions' => [ @@ -43270,26 +24720,17 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', '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' => 'Queries the value and time to live (TTL) of a key.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -43302,32 +24743,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239214', - 'abilityTreeNodes' => [ - 'FEATUREdcdnGMYWU5', - ], + 'abilityTreeNodes' => ['FEATUREdcdnGMYWU5'], ], 'parameters' => [ [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace that you specify when you call the [CreateKvNamespace](~~2850317~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'test_namespace', - ], + 'schema' => ['description' => 'The name of the namespace that you specify when you call the [CreateKvNamespace](~~2850317~~) operation.'."\n", 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test_namespace'], ], [ 'name' => 'Key', 'in' => 'query', - 'schema' => [ - 'description' => 'The key name for the query.'."\n", - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'test_key', - ], + 'schema' => ['description' => 'The key name for the query.'."\n", 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test_key'], ], ], 'responses' => [ @@ -43337,24 +24764,9 @@ 'description' => '', 'type' => 'object', 'properties' => [ - 'Value' => [ - 'description' => 'The value of the key. The value of the root node.'."\n", - 'type' => 'string', - 'title' => '', - 'example' => 'test_value', - ], - 'RequestId' => [ - 'description' => 'The expiration time of the key. Unit: seconds.'."\n", - 'type' => 'string', - 'title' => '', - 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', - ], - 'ExpirationTtl' => [ - 'description' => 'The expiration time of the key. Unit: seconds.'."\n", - 'type' => 'string', - 'title' => '', - 'example' => '3600', - ], + 'Value' => ['description' => 'The value of the key. The value of the root node.'."\n", 'type' => 'string', 'title' => '', 'example' => 'test_value'], + 'RequestId' => ['description' => 'The expiration time of the key. Unit: seconds.'."\n", 'type' => 'string', 'title' => '', 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE'], + 'ExpirationTtl' => ['description' => 'The expiration time of the key. Unit: seconds.'."\n", 'type' => 'string', 'title' => '', 'example' => '3600'], ], 'example' => '', ], @@ -43362,104 +24774,34 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidAccount.Malformed', - 'errorMessage' => 'The specified account is invalid.', - 'description' => 'The account number is not entered correctly, for example, the input is empty.', - ], - [ - 'errorCode' => 'InvalidNameSpace.Malformed', - 'errorMessage' => 'The specified namespace is invalid.', - 'description' => 'The bucket name is entered incorrectly, such as an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.Malformed', - 'errorMessage' => 'The specified key is invalid.', - 'description' => 'Key name input error, such as entering an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.ExceedsMaximum', - 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', - 'description' => 'The length of the requested key is too large.', - ], - [ - 'errorCode' => 'InvalidValue.ExceedsMaximum', - 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', - 'description' => 'The value deposited is too large.', - ], - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The specified parameters are invalid.', - 'description' => 'Parameter is illegal.', - ], + ['errorCode' => 'InvalidAccount.Malformed', 'errorMessage' => 'The specified account is invalid.', 'description' => 'The account number is not entered correctly, for example, the input is empty.'], + ['errorCode' => 'InvalidNameSpace.Malformed', 'errorMessage' => 'The specified namespace is invalid.', 'description' => 'The bucket name is entered incorrectly, such as an empty string.'], + ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified key is invalid.', 'description' => 'Key name input error, such as entering an empty string.'], + ['errorCode' => 'InvalidKey.ExceedsMaximum', 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', 'description' => 'The length of the requested key is too large.'], + ['errorCode' => 'InvalidValue.ExceedsMaximum', 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', 'description' => 'The value deposited is too large.'], + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The specified parameters are invalid.', 'description' => 'Parameter is illegal.'], ], 403 => [ - [ - 'errorCode' => 'InvalidKey.ExceedsCapacity', - 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', - 'description' => 'The capacity of the storage space exceeds the limit.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidParameters', - 'errorMessage' => 'The specified authentication parameters are invalid.', - 'description' => 'Authentication parameter input error.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'InvalidKey.ExceedsCapacity', 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', 'description' => 'The capacity of the storage space exceeds the limit.'], + ['errorCode' => 'Unauthorized.InvalidParameters', 'errorMessage' => 'The specified authentication parameters are invalid.', 'description' => 'Authentication parameter input error.'], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'InvalidAccount.NotFound', - 'errorMessage' => 'The specified account does not exist.', - 'description' => 'The specified account does not exist.', - ], - [ - 'errorCode' => 'InvalidNameSpace.NotFound', - 'errorMessage' => 'The specified namespace does not exist.', - 'description' => '', - ], - [ - 'errorCode' => 'InvalidKey.NotFound', - 'errorMessage' => 'The specified key does not exist.', - 'description' => 'The specified key-value pair does not exist.', - ], + ['errorCode' => 'InvalidAccount.NotFound', 'errorMessage' => 'The specified account does not exist.', 'description' => 'The specified account does not exist.'], + ['errorCode' => 'InvalidNameSpace.NotFound', 'errorMessage' => 'The specified namespace does not exist.', 'description' => ''], + ['errorCode' => 'InvalidKey.NotFound', 'errorMessage' => 'The specified key does not exist.', 'description' => 'The specified key-value pair does not exist.'], ], 406 => [ - [ - 'errorCode' => 'InvalidNameSpace.Duplicate', - 'errorMessage' => 'The specified namespace already exists.', - 'description' => 'Specified storage space', - ], - [ - 'errorCode' => 'InvalidNameSpace.QuotaFull', - 'errorMessage' => 'The maximum number of namespaces is exceeded.', - 'description' => 'The number of storage spaces exceeds the capacity limit.', - ], + ['errorCode' => 'InvalidNameSpace.Duplicate', 'errorMessage' => 'The specified namespace already exists.', 'description' => 'Specified storage space'], + ['errorCode' => 'InvalidNameSpace.QuotaFull', 'errorMessage' => 'The maximum number of namespaces is exceeded.', 'description' => 'The number of storage spaces exceeds the capacity limit.'], ], 429 => [ - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests are submitted.', - 'description' => 'Submissions are too frequent, please try again later', - ], - [ - 'errorCode' => 'TooQuickRequests', - 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', - 'description' => 'The modification or deletion of key-value pairs is too frequent.', - ], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests are submitted.', 'description' => 'Submissions are too frequent, please try again later'], + ['errorCode' => 'TooQuickRequests', 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', 'description' => 'The modification or deletion of key-value pairs is too frequent.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetKvDetail', 'changeSet' => [], 'flowControl' => [ @@ -43469,13 +24811,8 @@ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Value\\": \\"test_value\\",\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\",\\n \\"ExpirationTtl\\": \\"3600\\"\\n}","type":"json"}]', ], 'GetKvNamespace' => [ - 'summary' => 'Queries the information about a namespace in your Alibaba Cloud account.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -43488,23 +24825,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239017', - 'abilityTreeNodes' => [ - 'FEATUREdcdnGMYWU5', - ], + 'abilityTreeNodes' => ['FEATUREdcdnGMYWU5'], ], 'parameters' => [ [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace that you specify when you call the [CreateKvNamespace](~~2850317~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_namespace', - 'maxLength' => 64, - 'pattern' => '^[0-9a-zA-Z_-]+$', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the namespace. You specify this name when calling the [CreateKvNamespace](~~2850317~~) operation.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'pattern' => '^[0-9a-zA-Z_-]+$', 'example' => 'test_namespace', 'title' => ''], ], ], 'responses' => [ @@ -43512,69 +24839,25 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the namespace. Valid values:'."\n" - ."\n" - .'* **online**: working as expected.'."\n" - .'* **delete**: pending deletion.'."\n" - .'* **deleting**: being deleted.'."\n" - .'* **deleted**: deleted.'."\n", - 'type' => 'string', - 'example' => 'online', - 'title' => '', - ], - 'Namespace' => [ - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'example' => 'test_namespace', - 'title' => '', - ], - 'NamespaceId' => [ - 'description' => 'The ID of the namespace.'."\n", - 'type' => 'string', - 'example' => '643355322374688768', - 'title' => '', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', - 'title' => '', - ], - 'Description' => [ - 'description' => 'The description of the namespace.'."\n", - 'type' => 'string', - 'example' => 'this is a test namespace.', - 'title' => '', - ], - 'CapacityString' => [ - 'description' => 'The available capacity of the namespace.'."\n", - 'type' => 'string', - 'example' => '1 GB', - 'title' => '', - ], - 'CapacityUsedString' => [ - 'description' => 'The used capacity of the namespace.'."\n", - 'type' => 'string', - 'example' => '100 MB', - 'title' => '', - ], - 'Capacity' => [ - 'description' => 'The available capacity of the namespace. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1073741824', - 'title' => '', - ], - 'CapacityUsed' => [ - 'description' => 'The used capacity of the namespace. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10048576', - 'title' => '', - ], + 'Status' => ['description' => 'The status of the namespace. Valid values:'."\n" + ."\n" + .'- **online**: The namespace is active.'."\n" + ."\n" + .'- **delete**: The namespace is marked for deletion.'."\n" + ."\n" + .'- **deleting**: The namespace is being deleted.'."\n" + ."\n" + .'- **deleted**: The namespace has been deleted.', 'type' => 'string', 'example' => 'online', 'title' => ''], + 'Namespace' => ['description' => 'The name of the namespace.', 'type' => 'string', 'example' => 'test_namespace', 'title' => ''], + 'NamespaceId' => ['description' => 'The ID of the namespace.', 'type' => 'string', 'example' => '643355322374688768', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', 'title' => ''], + 'Description' => ['description' => 'The description of the namespace.', 'type' => 'string', 'example' => 'this is a test namespace.', 'title' => ''], + 'CapacityString' => ['description' => 'The available capacity of the namespace, formatted as a human-readable string.', 'type' => 'string', 'example' => '1 GB', 'title' => ''], + 'CapacityUsedString' => ['description' => 'The used capacity of the namespace, formatted as a human-readable string.', 'type' => 'string', 'example' => '100 MB', 'title' => ''], + 'Capacity' => ['description' => 'The available capacity of the namespace, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1073741824', 'title' => ''], + 'CapacityUsed' => ['description' => 'The used capacity of the namespace, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '10048576', 'title' => ''], ], - 'description' => '', + 'description' => 'The response parameters.', 'title' => '', 'example' => '', ], @@ -43582,153 +24865,67 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidAccount.Malformed', - 'errorMessage' => 'The specified account is invalid.', - 'description' => 'The account number is not entered correctly, for example, the input is empty.', - ], - [ - 'errorCode' => 'InvalidNameSpace.Malformed', - 'errorMessage' => 'The specified namespace is invalid.', - 'description' => 'The bucket name is entered incorrectly, such as an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.Malformed', - 'errorMessage' => 'The specified key is invalid.', - 'description' => 'Key name input error, such as entering an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.ExceedsMaximum', - 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', - 'description' => 'The length of the requested key is too large.', - ], - [ - 'errorCode' => 'InvalidValue.ExceedsMaximum', - 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', - 'description' => 'The value deposited is too large.', - ], + ['errorCode' => 'InvalidAccount.Malformed', 'errorMessage' => 'The specified account is invalid.', 'description' => 'The account number is not entered correctly, for example, the input is empty.'], + ['errorCode' => 'InvalidNameSpace.Malformed', 'errorMessage' => 'The specified namespace is invalid.', 'description' => 'The bucket name is entered incorrectly, such as an empty string.'], + ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified key is invalid.', 'description' => 'Key name input error, such as entering an empty string.'], + ['errorCode' => 'InvalidKey.ExceedsMaximum', 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', 'description' => 'The length of the requested key is too large.'], + ['errorCode' => 'InvalidValue.ExceedsMaximum', 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', 'description' => 'The value deposited is too large.'], ], 403 => [ - [ - 'errorCode' => 'InvalidKey.ExceedsCapacity', - 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', - 'description' => 'The capacity of the storage space exceeds the limit.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidParameters', - 'errorMessage' => 'The specified authentication parameters are invalid.', - 'description' => 'Authentication parameter input error.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'InvalidKey.ExceedsCapacity', 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', 'description' => 'The capacity of the storage space exceeds the limit.'], + ['errorCode' => 'Unauthorized.InvalidParameters', 'errorMessage' => 'The specified authentication parameters are invalid.', 'description' => 'Authentication parameter input error.'], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'InvalidAccount.NotFound', - 'errorMessage' => 'The specified account does not exist.', - 'description' => 'The specified account does not exist.', - ], - [ - 'errorCode' => 'InvalidNameSpace.NotFound', - 'errorMessage' => 'The specified namespace does not exist.', - 'description' => '', - ], - [ - 'errorCode' => 'InvalidKey.NotFound', - 'errorMessage' => 'The specified key does not exist.', - 'description' => 'The specified key-value pair does not exist.', - ], + ['errorCode' => 'InvalidAccount.NotFound', 'errorMessage' => 'The specified account does not exist.', 'description' => 'The specified account does not exist.'], + ['errorCode' => 'InvalidNameSpace.NotFound', 'errorMessage' => 'The specified namespace does not exist.', 'description' => ''], + ['errorCode' => 'InvalidKey.NotFound', 'errorMessage' => 'The specified key does not exist.', 'description' => 'The specified key-value pair does not exist.'], ], 406 => [ - [ - 'errorCode' => 'InvalidNameSpace.Duplicate', - 'errorMessage' => 'The specified namespace already exists.', - 'description' => 'Specified storage space', - ], - [ - 'errorCode' => 'InvalidNameSpace.QuotaFull', - 'errorMessage' => 'The maximum number of namespaces is exceeded.', - 'description' => 'The number of storage spaces exceeds the capacity limit.', - ], + ['errorCode' => 'InvalidNameSpace.Duplicate', 'errorMessage' => 'The specified namespace already exists.', 'description' => 'Specified storage space'], + ['errorCode' => 'InvalidNameSpace.QuotaFull', 'errorMessage' => 'The maximum number of namespaces is exceeded.', 'description' => 'The number of storage spaces exceeds the capacity limit.'], ], 429 => [ - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests are submitted.', - 'description' => 'Submissions are too frequent, please try again later', - ], - [ - 'errorCode' => 'TooQuickRequests', - 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', - 'description' => 'The modification or deletion of key-value pairs is too frequent.', - ], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests are submitted.', 'description' => 'Submissions are too frequent, please try again later'], + ['errorCode' => 'TooQuickRequests', 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', 'description' => 'The modification or deletion of key-value pairs is too frequent.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - '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"}]', 'title' => 'GetKvNamespace', + 'summary' => 'Retrieves information about a specific namespace.', 'changeSet' => [ - [ - 'createdAt' => '2025-04-03T01:43:47.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-09-20T13:49:20.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-04-03T01:43:47.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-20T13:49:20.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '5', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetKvNamespace', - ], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetKvNamespace'], ], ], 'ramActions' => [ [ - 'operationType' => 'none', + 'operationType' => 'get', 'ramAction' => [ 'action' => 'esa:GetKvNamespace', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', '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' => 'Queries the details of a custom list, such as the name, description, type, and content.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Retrieves the details of a specific custom list. You can use this operation to query the properties of a specific list, including the name, description, kind, and list items.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -43741,89 +24938,37 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239602', - 'abilityTreeNodes' => [ - 'FEATUREdcdnL8HX1L', - ], + 'abilityTreeNodes' => ['FEATUREdcdnL8HX1L'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The ID of the custom list, which can be obtained by calling the [ListLists](~~2850217~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '40000001', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the custom list. You can obtain the ID by calling the [ListLists](~~2850217~~) operation.', 'type' => 'integer', 'format' => 'int64', 'example' => '40000001', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], - 'UpdateTime' => [ - 'title' => '', - 'description' => 'The time when the custom list was last modified.'."\n", - 'type' => 'string', - 'example' => '2024-01-01T00:00:00Z', - ], - 'Id' => [ - 'title' => '', - 'description' => 'The ID of the custom list.[](~~2850217~~)'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '40000001', - 'pattern' => '', - 'default' => '', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The name of the custom list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'example', - 'maxLength' => 128, - 'pattern' => '', - 'default' => '', - ], - 'Description' => [ - 'title' => '', - 'description' => 'The description of the custom list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a custom list', - 'maxLength' => 1024, - 'pattern' => '', - 'default' => '', - ], - 'Kind' => [ - 'title' => '', - 'description' => 'The type of the custom list.'."\n", - 'type' => 'string', - 'example' => 'ip', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], + 'UpdateTime' => ['title' => '', 'description' => 'The last update time of the custom list.'."\n" + ."\n" + .'Format: RFC 3339 / ISO 8601, UTC time zone (ending with Z).'."\n" + ."\n" + .'Example: 2026-06-10T14:23:45Z', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], + 'Id' => ['title' => '', 'description' => 'The ID of the custom list. You can obtain the ID by calling the [ListLists](~~2850217~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '40000001', 'pattern' => '', 'default' => ''], + 'Name' => ['title' => '', 'description' => 'The name of the custom list.', 'type' => 'string', 'required' => true, 'example' => 'example', 'maxLength' => 128, 'pattern' => '', 'default' => ''], + 'Description' => ['title' => '', 'description' => 'The description of the custom list.', 'type' => 'string', 'required' => false, 'example' => 'a custom list', 'maxLength' => 1024, 'pattern' => '', 'default' => ''], + 'Kind' => ['title' => '', 'description' => 'The kind of the custom list.', 'type' => 'string', 'example' => 'ip'], 'Items' => [ 'title' => '', - 'description' => 'The items in the custom list, which are displayed as an array.'."\n", + 'description' => 'The items of the custom list, displayed as an array.', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'The item in the custom list.'."\n", - 'type' => 'string', - 'example' => '10.1.1.1', - ], + 'items' => ['title' => '', 'description' => 'The custom list item.', 'type' => 'string', 'example' => '10.1.1.1'], 'example' => '', ], ], @@ -43833,41 +24978,24 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], '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"}]', - 'title' => 'GetList', + 'title' => 'Get custom list details', 'changeSet' => [ - [ - 'createdAt' => '2024-09-25T07:02:49.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T08:22:02.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-25T07:02:49.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T08:22:02.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetList', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetList'], ], ], 'ramActions' => [ @@ -43878,28 +25006,16 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], ], 'GetLoadBalancer' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Retrieves the details of a specific load balancer based on the specified site ID and load balancer ID.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -43912,164 +25028,73 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238515', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '监视器id。', - 'description' => 'The ID of the load balancer, used to uniquely identify the load balancer to be queried. This ID is returned directly when the load balancer is created, or it can be obtained through the [ListLoadBalancers](~~2868897~~) interface for querying all load balancers under a site.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '99867648760****', - ], + 'schema' => ['title' => '', 'description' => 'The load balancer ID, which uniquely identifies the load balancer to query. This ID is returned when the load balancer is created. You can also call the [ListLoadBalancers](~~2868897~~) operation to obtain all load balancers under a site.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '99867648760****'], ], [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1159101787****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1159101787****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data structure returned in a successful response, containing detailed configuration information of the load balancer.', + 'title' => '', + 'description' => 'The data structure returned upon a successful response, which contains the detailed configuration of the load balancer.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', - ], - 'Id' => [ - 'description' => 'The unique identifier ID of the load balancer.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '99867648760****', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The name of the load balancer.', - 'type' => 'string', - 'example' => 'lb.example.com', - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'The site ID to which the load balancer belongs.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11591017874****', - 'title' => '', - ], - 'Enabled' => [ - 'description' => 'Whether the load balancer is enabled.'."\n" - ."\n" - .'- true: Enabled.'."\n" - .'- false: Not enabled.', - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], - 'Ttl' => [ - 'description' => 'TTL value, the time-to-live for DNS records, with a default of 30 seconds.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - 'title' => '', - ], - 'SessionAffinity' => [ - 'description' => 'Session persistence, with values:'."\n" - .'- off: Not enabled.'."\n" - .'- ip: Session persistence by IP.'."\n" - .'- cookie: Session persistence by cookie.', - 'type' => 'string', - 'example' => 'ip', - 'title' => '', - ], - 'FallbackPool' => [ - 'description' => 'The fallback pool ID, to which traffic will be redirected if all other pools are unavailable.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '96228666776****', - 'title' => '', - ], - 'SteeringPolicy' => [ - 'description' => 'Load balancing policy.', - 'type' => 'string', - 'example' => 'order', - 'title' => '', - ], - 'Description' => [ - 'description' => 'Description of the load balancer.', - 'type' => 'string', - 'example' => 'test', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'], + 'Id' => ['description' => 'The unique ID of the load balancer.', 'type' => 'integer', 'format' => 'int64', 'example' => '99867648760****', 'title' => ''], + 'Name' => ['description' => 'The name of the load balancer.', 'type' => 'string', 'example' => 'lb.example.com', 'title' => ''], + 'SiteId' => ['description' => 'The ID of the site to which the load balancer belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '11591017874****', 'title' => ''], + 'Enabled' => ['description' => 'Indicates whether the load balancer is enabled.'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Ttl' => ['description' => 'The TTL value, which specifies the time-to-live of the DNS record. Default value: 30 seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'SessionAffinity' => ['description' => 'The session persistence setting. Valid values:'."\n" + .'- off: disabled.'."\n" + .'- ip: IP-based session persistence.'."\n" + .'- cookie: cookie-based session persistence.'."\n" + .'- http_header: HTTP header-based session persistence.', 'type' => 'string', 'example' => 'ip', 'title' => ''], + 'FallbackPool' => ['description' => 'The fallback pool ID. When all other pools are unavailable, traffic is redirected to this pool.', 'type' => 'integer', 'format' => 'int64', 'example' => '96228666776****', 'title' => ''], + 'SteeringPolicy' => ['description' => 'The load balancing policy.', 'type' => 'string', 'example' => 'order', 'title' => ''], + 'Description' => ['description' => 'The description of the load balancer.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'AdaptiveRouting' => [ - 'description' => 'Cross-pool failover configuration.', + 'description' => 'The cross-origin pool back-to-origin configuration.', 'type' => 'object', 'properties' => [ - 'FailoverAcrossPools' => [ - 'description' => 'Whether to fail over across pools.'."\n" - ."\n" - .'- true: Yes.'."\n" - .'- false: No.', - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], + 'FailoverAcrossPools' => ['description' => 'Indicates whether failover across origin pools is enabled.'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'OriginLevelRetry' => ['description' => 'Specifies whether to retry the next IP address when back-to-origin fails and the origin server is a domain name that resolves to multiple IP addresses.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'DefaultPools' => [ - 'description' => 'List of default pool IDs.', + 'description' => 'The list of default pool IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'Default pool.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '96228666776****', - 'title' => '', - ], + 'items' => ['description' => 'The default pool.', 'type' => 'integer', 'format' => 'int64', 'example' => '96228666776****', 'title' => ''], 'title' => '', 'example' => '', ], 'RandomSteering' => [ - 'description' => 'Weighted round-robin configuration, used to control the traffic distribution weights among different pools.', + 'description' => 'The weighted round-robin configuration, which controls the traffic distribution weight across different pools.', 'type' => 'object', 'properties' => [ - 'DefaultWeight' => [ - 'description' => 'The default round-robin weight, used for all pools that do not have individually specified weights. The value range is 0-100.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - 'title' => '', - ], + 'DefaultWeight' => ['description' => 'The default round-robin weight applied to all pools that do not have an individually specified weight. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], 'PoolWeights' => [ - 'description' => 'Weight configurations for each backend server pool, where the key is the pool ID and the value is the weight coefficient. The weight coefficient represents the relative traffic distribution ratio.', + 'description' => 'The weight configuration for each backend server pool. The key is the pool ID and the value is the weight coefficient. The weight coefficient represents the relative proportion of traffic distribution.', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => 'The weight of a single origin pool, a number between 0-100, where 0 indicates no traffic should be directed to that pool.', - 'example' => '50', - 'title' => '', - ], + 'additionalProperties' => ['description' => 'The weight of a single origin pool. Valid values: 0 to 100. A value of 0 indicates that no traffic is routed to this origin pool.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], 'title' => '', 'example' => '', ], @@ -44078,138 +25103,86 @@ 'example' => '', ], 'Rules' => [ - 'description' => 'A list of rule configurations, used to define behavior under specific conditions.', + 'description' => 'The list of rule configurations that define behaviors under specific conditions.', 'type' => 'array', 'items' => [ - 'description' => 'Configuration of rules within the rule set.', + 'description' => 'The rule configuration in the rule set.', 'type' => 'object', 'properties' => [ 'FixedResponse' => [ - 'description' => 'Executes a specified response after matching the rule.', + 'description' => 'The fixed response content returned when the rule is matched.', 'type' => 'object', 'properties' => [ - 'ContentType' => [ - 'description' => 'The Content-Type field in the HTTP Header.', - 'type' => 'string', - 'example' => 'application/json', - 'title' => '', - ], - 'Location' => [ - 'description' => 'The location field in the HTTP response.', - 'type' => 'string', - 'example' => 'http://www.example.com/index.html', - 'title' => '', - ], - 'MessageBody' => [ - 'description' => 'The body value of the response.', - 'type' => 'string', - 'example' => 'Hello World.', - 'title' => '', - ], - 'StatusCode' => [ - 'description' => 'Status code.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - 'title' => '', - ], + 'ContentType' => ['description' => 'The Content-Type field in the HTTP header.', 'type' => 'string', 'example' => 'application/json', 'title' => ''], + 'Location' => ['description' => 'The location field in the HTTP response.', 'type' => 'string', 'example' => 'http://www.example.com/index.html', 'title' => ''], + 'MessageBody' => ['description' => 'The response body value.', 'type' => 'string', 'example' => 'Hello World.', 'title' => ''], + 'StatusCode' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], 'title' => '', 'example' => '', ], - 'Overrides' => [ - 'description' => 'Modifies the load balancer configuration for the corresponding request after matching the rule. The fields in this configuration will override the corresponding fields in the load balancer\'s configuration.', - '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" - .' }', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding global configurations. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'example' => 'http.request.uri.path contains "/testing"', - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'Rule name. This parameter is not required when adding global configurations.', - 'type' => 'string', - 'example' => 'r2', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Rule switch. This parameter is not required when adding global configurations. Possible values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'off', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'Rule execution order. The higher the number, the higher the priority.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Terminates' => [ - 'description' => 'Whether to terminate the execution of subsequent rules.'."\n" - ."\n" - .'- true: Yes.'."\n" - .'- false: No, default value.', - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], + 'Overrides' => ['description' => 'The load balancing configuration overrides applied to matching requests. The configured fields override the corresponding fields in the load balancer configuration.', '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" + .' }', 'title' => ''], + 'Rule' => ['description' => 'The rule content, which uses conditional expressions to match user requests. This parameter is not required when you add a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + .'- Match specific requests: Set the value to a custom expression, such as (http.host eq \\"video.example.com\\").', 'type' => 'string', 'example' => 'http.request.uri.path contains "/testing"', 'title' => ''], + 'RuleName' => ['description' => 'The rule name. This parameter is not required when you add a global configuration.', 'type' => 'string', 'example' => 'r2', 'title' => ''], + 'RuleEnable' => ['description' => 'The rule switch. This parameter is not required when you add a global configuration. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'Sequence' => ['description' => 'The rule execution order. A larger value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Terminates' => ['description' => 'Indicates whether to terminate the execution of subsequent rules.'."\n" + ."\n" + .'- true: Yes.'."\n" + .'- false: No. This is the default value.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', @@ -44218,128 +25191,48 @@ 'example' => '', ], 'Monitor' => [ - 'description' => 'Monitor configuration.', + 'description' => 'The monitor configuration.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'Monitor protocol type, such as HTTP, used for health checks. When the value is `off`, it indicates that no check is performed.', - 'type' => 'string', - 'example' => 'HTTP', - 'title' => '', - ], - 'Method' => [ - 'description' => 'Health check method.', - 'type' => 'string', - 'example' => 'GET', - 'title' => '', - ], - 'Port' => [ - 'description' => 'Target port.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - 'title' => '', - ], - 'Path' => [ - 'description' => 'Path.', - 'type' => 'string', - 'example' => '/', - 'title' => '', - ], - 'Interval' => [ - 'description' => 'Health check interval, in seconds.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - 'title' => '', - ], - 'ExpectedCodes' => [ - 'description' => 'Expected status codes, such as 200, 202, for successful HTTP responses.', - 'type' => 'string', - 'example' => '200,202', - 'title' => '', - ], - 'FollowRedirects' => [ - 'description' => 'Whether to follow redirects.'."\n" - ."\n" - .'- true: Yes.'."\n" - .'- false: No.', - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], - 'ConsecutiveUp' => [ - 'description' => 'The number of consecutive successful probes required to consider the target as healthy, for example, `3`.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'title' => '', - ], - 'ConsecutiveDown' => [ - 'description' => 'The number of consecutive failed probes required to consider the target as unhealthy, for example, `5`.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'title' => '', - ], - 'Header' => [ - 'description' => 'The HTTP headers to be included in the probe request.', - 'type' => 'any', - 'example' => '{'."\n" - .' "host": ['."\n" - .' "example1.com",'."\n" - .' "example2.com"'."\n" - .' ]'."\n" - .' }', - 'title' => '', - ], - 'Timeout' => [ - 'description' => 'The timeout for the health check, in seconds.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'title' => '', - ], - 'MonitoringRegion' => [ - 'description' => 'The area where the detection point is located. The default value is Global.'."\n" - ."\n" - .'- Global: Global.'."\n" - .'- ChineseMainland: the Chinese mainland.'."\n" - .'- OutsideChineseMainland: Global (excluding the Chinese mainland).', - 'type' => 'string', - 'example' => 'Global', - 'title' => '', - ], + 'Type' => ['description' => 'The monitor protocol type, such as HTTP, used for health checks. A value of off indicates that no health check is performed.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'Method' => ['description' => 'The health check method.', 'type' => 'string', 'example' => 'GET', 'title' => ''], + 'Port' => ['description' => 'The target port.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'Path' => ['description' => 'The path.', 'type' => 'string', 'example' => '/', 'title' => ''], + 'Interval' => ['description' => 'The health check interval. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'ExpectedCodes' => ['description' => 'The expected status codes for a successful HTTP response, such as 200,202.', 'type' => 'string', 'example' => '200,202', 'title' => ''], + 'FollowRedirects' => ['description' => 'Indicates whether to follow redirects.'."\n" + ."\n" + .'- true: Yes.'."\n" + .'- false: No.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ConsecutiveUp' => ['description' => 'The number of consecutive successful probes required to consider the check successful, such as `3`.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'ConsecutiveDown' => ['description' => 'The number of consecutive failed probes required to consider the check failed, such as `5`.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'Header' => ['description' => 'The HTTP header information included in the probe request.', 'type' => 'any', 'example' => '{'."\n" + .' "host": ['."\n" + .' "example1.com",'."\n" + .' "example2.com"'."\n" + .' ]'."\n" + .' }', 'title' => ''], + 'Timeout' => ['description' => 'The health check timeout period. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'MonitoringRegion' => ['description' => 'The region where the probe nodes are located. Default value: Global.'."\n" + ."\n" + .'- Global: worldwide.'."\n" + .'- ChineseMainland: the Chinese mainland.'."\n" + .'- OutsideChineseMainland: worldwide (excluding the Chinese mainland).', 'type' => 'string', 'example' => 'Global', 'title' => ''], ], 'title' => '', 'example' => '', ], - 'Status' => [ - 'description' => 'The status of the load balancer.', - 'type' => 'string', - 'example' => 'healthy', - 'title' => '', - ], - 'SubRegionPools' => [ - 'description' => 'Address pools corresponding to secondary regions. When multiple secondary regions share a set of address pools, the keys can be concatenated with commas.', - 'type' => 'any', - 'example' => '{"AL,MO": [92298024898****],"CN-SH,CN-SX,CN-SC":[92304347804****,92843536908****]}', - 'title' => '', - ], - 'RegionPools' => [ - 'description' => 'Address pools corresponding to primary regions.', - 'type' => 'any', - 'example' => '{'."\n" - .' "ENAM": ['."\n" - .' 12345678****'."\n" - .' ],'."\n" - .' "WNAM": ['."\n" - .' 23456789****,'."\n" - .' 23456789****'."\n" - .' ]'."\n" - .'}', - 'title' => '', - ], + 'Status' => ['description' => 'The status of the load balancer.', 'type' => 'string', 'example' => 'healthy', 'title' => ''], + 'SubRegionPools' => ['description' => 'The pools mapped to secondary regions. When multiple secondary regions share the same set of pools, you can concatenate multiple secondary regions with commas as the key.', 'type' => 'any', 'example' => '{"AL,MO": [92298024898****],"CN-SH,CN-SX,CN-SC":[92304347804****,92843536908****]}', 'title' => ''], + 'RegionPools' => ['description' => 'The pools mapped to primary regions.', 'type' => 'any', 'example' => '{'."\n" + .' "ENAM": ['."\n" + .' 12345678****'."\n" + .' ],'."\n" + .' "WNAM": ['."\n" + .' 23456789****,'."\n" + .' 23456789****'."\n" + .' ]'."\n" + .'}', 'title' => ''], ], 'example' => '', ], @@ -44347,45 +25240,26 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => '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.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => '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.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + '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 \\"OriginLevelRetry\\": false\\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"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], - 'title' => 'Query a Single Load Balancer', - 'summary' => 'Query a Specific Load Balancer', - 'description' => 'This API allows users to query the configuration details of a specific load balancer by providing necessary authentication information and resource identifiers, including but not limited to name, session persistence strategy, routing policy, etc.', + 'title' => 'Query a single load balancer', + 'description' => 'This API allows you to query the configuration details of a specific load balancer by providing the required authentication information and resource identity. The details include but are not limited to the name, session persistence policy, and load balancing policy.', 'changeSet' => [ - [ - 'createdAt' => '2025-06-16T02:25:11.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-06-16T02:25:11.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetLoadBalancer', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLoadBalancer'], ], ], 'ramActions' => [ @@ -44396,25 +25270,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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', - ], + 'summary' => 'Retrieves the managed transform configuration for a site.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -44427,86 +25292,52 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257447', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling [ListSites](~~2850189~~).', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the site. You can obtain this ID by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The version number of the site. For sites with version management enabled, you can use this parameter to specify the effective version of the configuration, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The site version. If version management is enabled for the site, use this parameter to specify the version whose configuration you want to retrieve. The default is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'], 'AddClientGeolocationHeader' => [ - 'description' => 'Add visitor geolocation header. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', + 'description' => 'Indicates whether a header that contains the visitor\'s geolocation is added. Valid values:'."\n" + ."\n" + .'- on: Enables this feature.'."\n" + ."\n" + .'- off: Disables this feature.', + 'enumValueTitles' => ['off' => 'off', 'on' => 'on'], 'type' => 'string', - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], 'example' => 'on', 'title' => '', ], 'AddRealClientIpHeader' => [ - 'description' => 'Add the "ali-real-client-ip" header containing the real client IP. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', + 'description' => 'Indicates whether the "ali-real-client-ip" header is added to include the real client IP. Valid values:'."\n" + ."\n" + .'- on: Enables this feature.'."\n" + ."\n" + .'- off: Disables this feature.', + 'enumValueTitles' => ['off' => 'off', 'on' => 'on'], 'type' => 'string', - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], 'example' => 'on', 'title' => '', ], - 'SiteVersion' => [ - 'description' => 'The version number of the site. For sites with version management enabled, this parameter can be used to specify the site version for which the configuration takes effect, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'RealClientIpHeaderName' => [ - 'description' => 'The header name for the real client IP.', - 'type' => 'string', - 'example' => 'test_header', - 'title' => '', - ], + 'SiteVersion' => ['description' => 'The version of the site for which the configuration is returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'RealClientIpHeaderName' => ['description' => 'The real client IP header name.', 'type' => 'string', 'example' => 'test-header', 'title' => ''], ], 'example' => '', ], @@ -44514,32 +25345,18 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + '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"}]', 'title' => 'Query Managed Transform Configuration', - 'summary' => 'Query Managed Transform Configuration', 'changeSet' => [ - [ - 'createdAt' => '2025-05-09T05:58:30.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-05-09T05:58:30.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetManagedTransform', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetManagedTransform'], ], ], 'ramActions' => [ @@ -44550,26 +25367,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => 'Query a single network optimization configuration', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -44581,34 +25388,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257603', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12312312213212', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12312312213212', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ConfigId, which can be obtained by calling the [ListNetworkOptimizations](~~2869051~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'Configuration ConfigId, which can be obtained by calling the [ListNetworkOptimizations](~~2869051~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '35281609698****', 'title' => ''], ], ], 'responses' => [ @@ -44618,103 +25409,35 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E', - ], - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '35281609698****', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'Configuration type, which can be used to query global or rule configurations. Value range:'."\n" - ."\n" - .'- global: Query global configuration.'."\n" - .'- rule: Query rule configuration.', - 'type' => 'string', - 'example' => 'global', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'Site configuration version number. For sites with version management enabled, this parameter can specify the effective site version, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'Rule execution order. The smaller the value, the higher the priority.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'example' => '(http.host eq \\"video.example.com\\")'."\n", - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], - 'SmartRouting' => [ - 'description' => 'Whether to enable smart routing service, default is disabled. Value range:'."\n" - .'- on: Enable'."\n" - .'- off: Disable', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Http2Origin' => [ - 'description' => 'Whether to enable HTTP2 origin, default is disabled. Value range:'."\n" - ."\n" - .'- on: Enable'."\n" - .'- off: Disable', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Websocket' => [ - 'description' => 'Whether to enable Websocket, default is enabled. Value range:'."\n" - .'- on: Enable'."\n" - .'- off: Disable', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Grpc' => [ - 'description' => 'Whether to enable GRPC, default is disabled. Value range:'."\n" - .'- on: Enable'."\n" - .'- off: Disable', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'UploadMaxFilesize' => [ - 'description' => 'Maximum upload file size in MB, with a range from 100 to 500.', - 'type' => 'string', - 'example' => '500', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E'], + 'ConfigId' => ['description' => 'Configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '35281609698****', 'title' => ''], + 'ConfigType' => ['description' => 'Configuration type, which can be used to query global or rule configurations. Value range:'."\n" + ."\n" + .'- global: Query global configuration.'."\n" + .'- rule: Query rule configuration.', 'type' => 'string', 'example' => 'global', 'title' => ''], + 'SiteVersion' => ['description' => 'Site configuration version number. For sites with version management enabled, this parameter can specify the effective site version, defaulting to version 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Sequence' => ['description' => 'Rule execution order. The smaller the value, the higher the priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'RuleEnable' => ['description' => 'Rule switch. This parameter is not required when adding a global configuration. Value range:'."\n" + .'- on: Enable.'."\n" + .'- off: Disable.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" + .'- Match all incoming requests: Set the value to true'."\n" + .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', 'type' => 'string', 'example' => '(http.host eq \\"video.example.com\\")'."\n", 'title' => ''], + 'RuleName' => ['description' => 'Rule name. This parameter is not required when adding a global configuration.', 'type' => 'string', 'example' => 'rule_example', 'title' => ''], + 'SmartRouting' => ['description' => 'Whether to enable smart routing service, default is disabled. Value range:'."\n" + .'- on: Enable'."\n" + .'- off: Disable', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Http2Origin' => ['description' => 'Whether to enable HTTP2 origin, default is disabled. Value range:'."\n" + ."\n" + .'- on: Enable'."\n" + .'- off: Disable', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Websocket' => ['description' => 'Whether to enable Websocket, default is enabled. Value range:'."\n" + .'- on: Enable'."\n" + .'- off: Disable', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Grpc' => ['description' => 'Whether to enable GRPC, default is disabled. Value range:'."\n" + .'- on: Enable'."\n" + .'- off: Disable', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'UploadMaxFilesize' => ['description' => 'Maximum upload file size in MB, with a range from 100 to 500.', 'type' => 'string', 'example' => '500', 'title' => ''], ], 'example' => '', ], @@ -44722,27 +25445,16 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'Query Site Network Optimization Configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetNetworkOptimization', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNetworkOptimization'], ], ], 'ramActions' => [ @@ -44753,12 +25465,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -44766,13 +25473,9 @@ 'operationType' => 'read', ], 'GetOriginCaCertificate' => [ - 'summary' => 'Obtain the CA certificate information of the origin server.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Retrieves the CA certificate information of an origin server.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -44785,171 +25488,55 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '261741', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'babaabcd****', - 'title' => '', - ], + 'schema' => ['description' => 'The certificate ID.', 'type' => 'string', 'required' => true, 'example' => 'babaabcd****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456789****', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the certificate.'."\n", - 'type' => 'string', - 'example' => 'OK', - 'title' => '', - ], - 'Certificate' => [ - 'description' => 'The certificate content.'."\n", - 'type' => 'string', - 'example' => '-----BEGIN CERTIFICATE-----', - 'title' => '', - ], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789****', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'Status' => ['description' => 'The certificate status.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Certificate' => ['description' => 'The certificate content.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----', 'title' => ''], 'Result' => [ - 'description' => 'The certificate information.'."\n", + 'description' => 'The certificate information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'example' => 'babaabcd****', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The certificate name.'."\n", - 'type' => 'string', - 'example' => 'yourCertName', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the certificate.'."\n", - 'type' => 'string', - 'example' => 'OK', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The certificate type.'."\n", - 'type' => 'string', - 'example' => 'upload', - 'title' => '', - ], - 'CommonName' => [ - 'description' => 'The Common Name of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com ', - 'title' => '', - ], - 'NotBefore' => [ - 'description' => 'The time when the certificate takes effect.'."\n", - 'type' => 'string', - 'example' => '2023-03-31 02:08:00', - 'title' => '', - ], - 'NotAfter' => [ - 'description' => 'The time when the certificate expires.'."\n", - 'type' => 'string', - 'example' => '2024-03-31 02:08:00', - 'title' => '', - ], - 'Issuer' => [ - 'description' => 'The certificate authority (CA) that issued the certificate.'."\n", - 'type' => 'string', - 'example' => 'GlobalSign nv-sa', - 'title' => '', - ], - 'SAN' => [ - 'description' => 'The Subject Alternative Name (SAN) of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com,*.example.com', - 'title' => '', - ], - 'SignatureAlgorithm' => [ - 'description' => 'The signature algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'SHA256-RSA', - 'title' => '', - ], - 'PubkeyAlgorithm' => [ - 'description' => 'The public-key algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'RSA', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the certificate was created.'."\n", - 'type' => 'string', - 'example' => '2024-03-05 18:24:04', - 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'The time when the certificate was updated.'."\n", - 'type' => 'string', - 'example' => '2024-03-05 18:24:04', - 'title' => '', - ], - 'SerialNumber' => [ - 'description' => 'The serial number of the certificate.'."\n", - 'type' => 'string', - 'example' => 'babaded901474b9693acf530e0fb1d**', - 'title' => '', - ], - 'FingerprintSha256' => [ - 'description' => 'The SHA-256 fingerprint of the certificate.'."\n", - 'type' => 'string', - 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', - 'title' => '', - ], + 'Id' => ['description' => 'The certificate ID.', 'type' => 'string', 'example' => 'babaabcd****', 'title' => ''], + 'Name' => ['description' => 'The certificate name.', 'type' => 'string', 'example' => 'yourCertName', 'title' => ''], + 'Status' => ['description' => 'The certificate status.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Type' => ['description' => 'The certificate type.', 'type' => 'string', 'example' => 'upload', 'title' => ''], + 'CommonName' => ['description' => 'The common name of the certificate.', 'type' => 'string', 'example' => 'www.example.com ', 'title' => ''], + 'NotBefore' => ['description' => 'The start time of the certificate validity period. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2023-03-31 02:08:00', 'title' => ''], + 'NotAfter' => ['description' => 'The end time of the certificate validity period. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-03-31 02:08:00', 'title' => ''], + 'Issuer' => ['description' => 'The certificate issuer.', 'type' => 'string', 'example' => 'GlobalSign nv-sa', 'title' => ''], + 'SAN' => ['description' => 'The Subject Alternative Name (SAN) of the certificate.', 'type' => 'string', 'example' => 'www.example.com,*.example.com', 'title' => ''], + 'SignatureAlgorithm' => ['description' => 'The signature algorithm of the certificate.', 'type' => 'string', 'example' => 'SHA256-RSA', 'title' => ''], + 'PubkeyAlgorithm' => ['description' => 'The public key algorithm of the certificate.', 'type' => 'string', 'example' => 'RSA', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-03-05 18:24:04', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-03-05 18:24:04', 'title' => ''], + 'SerialNumber' => ['description' => 'The certificate serial number.', 'type' => 'string', 'example' => 'babaded901474b9693acf530e0fb1d**', 'title' => ''], + 'FingerprintSha256' => ['description' => 'The SHA-256 fingerprint of the certificate.', 'type' => 'string', 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', 'title' => ''], ], 'title' => '', 'example' => '', ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3558df77-8a7a-4060-a900-2d7949403836', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3558df77-8a7a-4060-a900-2d7949403836', 'title' => ''], ], 'example' => '', ], @@ -44957,65 +25544,27 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'Id.MissingParameter', - 'errorMessage' => 'The parameter Id is required.', - 'description' => 'The required parameter Id is missing.', - ], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'Id.MissingParameter', 'errorMessage' => 'The parameter Id is required.', 'description' => 'The required parameter Id is missing.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'Certificate.NotFound', - 'errorMessage' => 'The specified certificate does not exist.', - 'description' => 'The specified certificate does not exist.', - ], + ['errorCode' => 'Certificate.NotFound', 'errorMessage' => 'The specified certificate does not exist.', 'description' => 'The specified certificate does not exist.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'Obtain CA certificate information of the origin server', + 'staticInfo' => ['returnType' => 'synchronous'], + '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"}]', + 'title' => 'Retrieve origin server CA certificate information', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '20', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetOriginCaCertificate', - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOriginCaCertificate'], ], ], 'ramActions' => [ @@ -45026,25 +25575,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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', - ], + 'summary' => 'Retrieves the back-to-origin client certificate information at the domain name granularity.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -45057,170 +25597,54 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '261753', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'babaabcd****', - 'title' => '', - ], + 'schema' => ['description' => 'The certificate ID.', 'type' => 'string', 'required' => true, 'example' => 'babaabcd****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456789****', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com'."\n", - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the certificate.', - 'type' => 'string', - 'example' => 'OK', - 'title' => '', - ], - 'Certificate' => [ - 'description' => 'The certificate content.'."\n", - 'type' => 'string', - 'example' => '-----BEGIN CERTIFICATE-----', - 'title' => '', - ], + 'SiteId' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789****', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com'."\n", 'title' => ''], + 'Status' => ['description' => 'The certificate status.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Certificate' => ['description' => 'The certificate content.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----', 'title' => ''], 'Result' => [ - 'description' => 'The certificate information.'."\n", + 'description' => 'The certificate information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'example' => 'babaabcd****', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The certificate name.'."\n", - 'type' => 'string', - 'example' => 'yourCertName', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the certificate.', - 'type' => 'string', - 'example' => 'OK', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The certificate type.'."\n", - 'type' => 'string', - 'example' => 'upload', - 'title' => '', - ], - 'CommonName' => [ - 'description' => 'The Common Name of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com', - 'title' => '', - ], - 'NotBefore' => [ - 'description' => 'The time when the certificate takes effect.'."\n", - 'type' => 'string', - 'example' => '2023-03-31 02:08:00', - 'title' => '', - ], - 'NotAfter' => [ - 'description' => 'The time when the certificate expires.'."\n", - 'type' => 'string', - 'example' => '2024-03-31 02:08:00', - 'title' => '', - ], - 'Issuer' => [ - 'description' => 'The certificate authority (CA) that issued the certificate.'."\n", - 'type' => 'string', - 'example' => 'DigiCert', - 'title' => '', - ], - 'SAN' => [ - 'description' => 'The Subject Alternative Name (SAN) of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com,*.example.com', - 'title' => '', - ], - 'SignatureAlgorithm' => [ - 'description' => 'The signature algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'SHA256-RSA', - 'title' => '', - ], - 'PubkeyAlgorithm' => [ - 'description' => 'The public-key algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'RSA', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the certificate was created.'."\n", - 'type' => 'string', - 'example' => '2020-05-12 02:00:53', - 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'The time when the certificate was updated.'."\n", - 'type' => 'string', - 'example' => '2024-03-05 18:24:04', - 'title' => '', - ], - 'SerialNumber' => [ - 'description' => 'The serial number of the certificate.'."\n", - 'type' => 'string', - 'example' => 'babaded901474b9693acf530e0fb1d**', - 'title' => '', - ], - 'FingerprintSha256' => [ - 'description' => 'The SHA-256 fingerprint of the certificate.'."\n", - 'type' => 'string', - 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', - 'title' => '', - ], + 'Id' => ['description' => 'The certificate ID.', 'type' => 'string', 'example' => 'babaabcd****', 'title' => ''], + 'Name' => ['description' => 'The certificate name.', 'type' => 'string', 'example' => 'yourCertName', 'title' => ''], + 'Status' => ['description' => 'The certificate status.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Type' => ['description' => 'The certificate type.', 'type' => 'string', 'example' => 'upload', 'title' => ''], + 'CommonName' => ['description' => 'The common name of the certificate.', 'type' => 'string', 'example' => 'www.example.com', 'title' => ''], + 'NotBefore' => ['description' => 'The start time of the certificate validity period. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2023-03-31 02:08:00', 'title' => ''], + 'NotAfter' => ['description' => 'The end time of the certificate validity period. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-03-31 02:08:00', 'title' => ''], + 'Issuer' => ['description' => 'The certificate issue authority.', 'type' => 'string', 'example' => 'DigiCert', 'title' => ''], + 'SAN' => ['description' => 'The Subject Alternative Name (SAN) of the certificate.', 'type' => 'string', 'example' => 'www.example.com,*.example.com', 'title' => ''], + 'SignatureAlgorithm' => ['description' => 'The signature algorithm of the certificate.', 'type' => 'string', 'example' => 'SHA256-RSA', 'title' => ''], + 'PubkeyAlgorithm' => ['description' => 'The public key algorithm of the certificate.', 'type' => 'string', 'example' => 'RSA', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2020-05-12 02:00:53', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-03-05 18:24:04', 'title' => ''], + 'SerialNumber' => ['description' => 'The certificate serial number.', 'type' => 'string', 'example' => 'babaded901474b9693acf530e0fb1d**', 'title' => ''], + 'FingerprintSha256' => ['description' => 'The SHA-256 fingerprint of the certificate.', 'type' => 'string', 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', 'title' => ''], 'Hostnames' => [ - 'description' => 'The domain names to associate.'."\n", + 'description' => 'The list of associated domain names.', 'type' => 'array', - 'items' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'example' => '[\'www.example.com\', \'mail.example.com\']', - 'title' => '', - ], + 'items' => ['description' => 'The domain name.', 'type' => 'string', 'example' => '[\'www.example.com\', \'mail.example.com\']', 'title' => ''], 'title' => '', 'example' => '', ], @@ -45228,12 +25652,7 @@ 'title' => '', 'example' => '', ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', 'title' => ''], ], 'example' => '', ], @@ -45241,63 +25660,26 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'Id.MissingParameter', - 'errorMessage' => 'The parameter Id is required.', - 'description' => 'The required parameter Id is missing.', - ], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'Id.MissingParameter', 'errorMessage' => 'The parameter Id is required.', 'description' => 'The required parameter Id is missing.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'Certificate.NotFound', - 'errorMessage' => 'The specified certificate does not exist.', - 'description' => 'The specified certificate does not exist.', - ], + ['errorCode' => 'Certificate.NotFound', 'errorMessage' => 'The specified certificate does not exist.', 'description' => 'The specified certificate does not exist.'], ], ], - 'title' => 'Obtain origin fetch client certificate information by domain name granularity ', - 'summary' => 'Obtain domain name granularity origin fetch client certificate information. ', + '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"}]', + 'title' => 'Retrieve back-to-origin client certificate information at the domain name granularity', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '20', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetOriginClientCertificate', - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOriginClientCertificate'], ], ], 'ramActions' => [ @@ -45308,26 +25690,15 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => 'Obtain the list of domain names attached to a client certificate for origin fetch at domain name granularity.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -45340,79 +25711,38 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '261755', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the certificate.', - 'type' => 'string', - 'required' => true, - 'example' => 'babaabcd****', - 'title' => '', - ], + 'schema' => ['description' => 'The certificate ID.', 'type' => 'string', 'required' => true, 'example' => 'babaabcd****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456789****', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com ', - 'title' => '', - ], - 'Id' => [ - 'description' => 'The ID of the client certificate.', - 'type' => 'string', - 'example' => 'babaabcd****', - 'title' => '', - ], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789****', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com ', 'title' => ''], + 'Id' => ['description' => 'The certificate ID.', 'type' => 'string', 'example' => 'babaabcd****', 'title' => ''], 'Hostnames' => [ - 'description' => 'The domain names to associate.'."\n", + 'description' => 'The associated hostnames.', 'type' => 'array', - 'items' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'example' => 'www.example.com ', - 'title' => '', - ], + 'items' => ['description' => 'A hostname.', 'type' => 'string', 'example' => 'www.example.com ', 'title' => ''], 'title' => '', 'example' => '', ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', 'title' => ''], ], 'example' => '', ], @@ -45420,57 +25750,25 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'Id.MissingParameter', - 'errorMessage' => 'The parameter Id is required.', - 'description' => 'The required parameter Id is missing.', - ], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Id.MissingParameter', 'errorMessage' => 'The parameter Id is required.', 'description' => 'The required parameter Id is missing.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'Certificate.NotFound', - 'errorMessage' => 'The specified certificate does not exist.', - 'description' => 'The specified certificate does not exist.', - ], + ['errorCode' => 'Certificate.NotFound', 'errorMessage' => 'The specified certificate does not exist.', 'description' => 'The specified certificate does not exist.'], ], ], 'title' => 'Obtain the list of domain names attached to a client certificate for origin fetch at domain name granularity', + 'summary' => 'Retrieves the hostnames associated with a specific origin client certificate.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '20', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetOriginClientCertificateHostnames', - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOriginClientCertificateHostnames'], ], ], 'ramActions' => [ @@ -45481,12 +25779,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -45494,13 +25787,9 @@ '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' => [ - 'summary' => 'Query a specific origin pool', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Retrieves a specific source address pool by its source address pool ID.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -45513,108 +25802,50 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238601', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '监视器id。', - 'description' => 'The ID of the origin pool, which can be obtained by calling the [ListOriginPools](~~2863947~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1038520525196928', - ], + 'schema' => ['title' => '监视器id。', 'description' => 'The origin pool ID. To get it, call [ListOriginPools](~~2863947~~).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1038520525196928'], ], [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the site, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '216558609793952', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. To get it, call [ListSites](~~2850189~~).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '216558609793952', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - ], - 'Id' => [ - 'description' => 'Origin pool ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '103852052519****', - 'title' => '', - ], - 'Name' => [ - 'description' => 'Name of the origin pool. The name is unique under a single site.', - 'type' => 'string', - 'example' => 'pool1', - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'ID of the site to which the origin pool belongs.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '21655860979****', - 'title' => '', - ], - 'RecordName' => [ - 'description' => 'The domain name assigned to the origin pool, which can be used as the origin address for records under the site.', - 'type' => 'string', - 'example' => 'pool1.example.com', - 'title' => '', - ], - 'Enabled' => [ - 'description' => 'Whether the origin pool is enabled:'."\n" - ."\n" - .'- true: Enabled;'."\n" - .'- false: Disabled.', - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'], + 'Id' => ['description' => 'The origin pool ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '103852052519****', 'title' => ''], + 'Name' => ['description' => 'The name of the origin pool. The name must be unique within a site.', 'type' => 'string', 'example' => 'pool1', 'title' => ''], + 'SiteId' => ['description' => 'The ID of the site that contains the origin pool.', 'type' => 'integer', 'format' => 'int64', 'example' => '21655860979****', 'title' => ''], + 'RecordName' => ['description' => 'The domain name assigned to the origin pool. It serves as the origin address for records within the site.', 'type' => 'string', 'example' => 'pool1.example.com', 'title' => ''], + 'Enabled' => ['description' => 'Specifies if the origin pool is enabled.'."\n" + ."\n" + .'- true: The origin pool is enabled.'."\n" + ."\n" + .'- false: The origin pool is disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'References' => [ - 'description' => 'Reference information for the origin pool. The origin pool is considered referenced when it is configured in a load balancer or set as the origin for a record.', + 'description' => 'Resources that reference the origin pool. An origin pool is referenced if a load balancer or record uses it as an origin.', 'type' => 'object', 'properties' => [ 'LoadBalancers' => [ - 'description' => 'List of load balancers using this origin pool.', + 'description' => 'The load balancers that use this origin pool.', 'type' => 'array', 'items' => [ - 'description' => 'Information about the load balancers using this origin pool.', + 'description' => 'A load balancer that uses this origin pool.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'Name of the load balancer.', - 'type' => 'string', - 'example' => 'lb1.example.com', - 'title' => '', - ], - 'Id' => [ - 'description' => 'ID of the load balancer.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '99874066052****', - 'title' => '', - ], + 'Name' => ['description' => 'The name of the load balancer.', 'type' => 'string', 'example' => 'lb1.example.com', 'title' => ''], + 'Id' => ['description' => 'The ID of the load balancer.', 'type' => 'integer', 'format' => 'int64', 'example' => '99874066052****', 'title' => ''], ], 'title' => '', 'example' => '', @@ -45623,25 +25854,14 @@ 'example' => '', ], 'DnsRecords' => [ - 'description' => 'List of layer 7 records using this origin pool as the origin.', + 'description' => 'The Layer 7 records that use this origin pool as their origin.', 'type' => 'array', 'items' => [ - 'description' => 'Information about the layer 7 records using this origin pool as the origin.', + 'description' => 'A Layer 7 record that uses this origin pool as its origin.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'Record name.', - 'type' => 'string', - 'example' => 'www.example.com', - 'title' => '', - ], - 'Id' => [ - 'description' => 'Record ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '104285288635****', - 'title' => '', - ], + 'Name' => ['description' => 'The name of the record.', 'type' => 'string', 'example' => 'www.example.com', 'title' => ''], + 'Id' => ['description' => 'The ID of the record.', 'type' => 'integer', 'format' => 'int64', 'example' => '104285288635****', 'title' => ''], ], 'title' => '', 'example' => '', @@ -45650,25 +25870,14 @@ 'example' => '', ], 'IPARecords' => [ - 'description' => 'List of layer 4 records using this origin pool as the origin.', + 'description' => 'The Layer 4 records that use this origin pool as their origin.', 'type' => 'array', 'items' => [ - 'description' => 'Information about the layer 4 records using this origin pool as the origin.', + 'description' => 'A Layer 4 record that uses this origin pool as its origin.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'Record name.', - 'type' => 'string', - 'example' => 'ipa.example.com', - 'title' => '', - ], - 'Id' => [ - 'description' => '记录ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '104285288635****', - 'title' => '', - ], + 'Name' => ['description' => 'The name of the record.', 'type' => 'string', 'example' => 'ipa.example.com', 'title' => ''], + 'Id' => ['description' => 'The ID of the record.', 'type' => 'integer', 'format' => 'int64', 'example' => '104285288635****', 'title' => ''], ], 'title' => '', 'example' => '', @@ -45680,124 +25889,65 @@ 'title' => '', 'example' => '', ], - 'ReferenceLBCount' => [ - 'description' => 'The number of load balancers that reference this origin pool.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'title' => '', - ], + 'ReferenceLBCount' => ['description' => 'The number of load balancers that reference this origin pool.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'Origins' => [ - 'description' => 'Information about the origins added to the origin pool.', + 'description' => 'The origins in the origin pool.', 'type' => 'array', 'items' => [ - 'description' => 'Information about the origins added to the origin pool.', + 'description' => 'An origin in the origin pool.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the origin.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '99750209487****', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The name of the origin.', - 'type' => 'string', - 'example' => 'origin1', - 'title' => '', - ], - 'Address' => [ - 'description' => 'The address of the origin, e.g., www.example.com.', - 'type' => 'string', - 'example' => 'www.example.com', - 'title' => '', - ], - 'Enabled' => [ - 'description' => 'Whether the origin is enabled:'."\n" - ."\n" - .'- true: Enabled;'."\n" - .'- false: Disabled.', - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], - 'Weight' => [ - 'description' => 'The weight, an integer between 0 and 100.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The type of the origin:'."\n" - ."\n" - .'- ip_domain: IP or domain type origin;'."\n" - .'- OSS: OSS address origin;'."\n" - .'- S3: AWS S3 origin.', - 'type' => 'string', - 'example' => 'ip_domain', - 'title' => '', - ], - 'Header' => [ - 'description' => 'The request header to be included when fetching from the origin, only supports Host.', - 'type' => 'any', - 'example' => '{'."\n" - .' "Host": ['."\n" - .' "example.com"'."\n" - .' ]'."\n" - .' }', - 'title' => '', - ], + 'Id' => ['description' => 'The origin ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '99750209487****', 'title' => ''], + 'Name' => ['description' => 'The origin name.', 'type' => 'string', 'example' => 'origin1', 'title' => ''], + 'Address' => ['description' => 'The origin address. For example, www\\.example.com.', 'type' => 'string', 'example' => 'www.example.com', 'title' => ''], + 'Enabled' => ['description' => 'Specifies if the origin is enabled.'."\n" + ."\n" + .'- true: The origin is enabled.'."\n" + ."\n" + .'- false: The origin is disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Weight' => ['description' => 'The weight of the origin. Must be an integer from 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'Type' => ['description' => 'The type of the origin.'."\n" + ."\n" + .'- ip\\_domain: An IP address or a domain name.'."\n" + ."\n" + .'- OSS: An OSS bucket.'."\n" + ."\n" + .'- S3: An AWS S3 bucket.', 'type' => 'string', 'example' => 'ip_domain', 'title' => ''], + 'Header' => ['description' => 'The request header to include in origin requests. Only the Host header is supported.', 'type' => 'any', 'example' => '{'."\n" + .' "Host": ['."\n" + .' "example.com"'."\n" + .' ]'."\n" + .' }', 'title' => ''], 'AuthConf' => [ - 'description' => 'Authentication information. When the origin is an OSS or S3, and authentication is required, you need to provide the relevant configuration information.', + 'description' => 'The authentication configuration. This parameter is required if the origin is an OSS or S3 bucket that requires authentication.', 'type' => 'object', 'properties' => [ - 'AuthType' => [ - 'description' => 'The type of authentication:'."\n" - ."\n" - .'- public: Public read/write, used when the origin is OSS or S3 and is publicly readable/writable;'."\n" - .'- private_same_account: Private same account, used when the origin is OSS and the authentication type is private within the same account;'."\n" - .'- private_cross_account: Private cross account, used when the origin is OSS and the authentication type is private across accounts;'."\n" - .'- private: Used when the origin is S3 and the authentication type is private.', - 'type' => 'string', - 'example' => 'public', - 'title' => '', - ], - 'AccessKey' => [ - 'description' => 'The AccessKey required when AuthType is set to private_cross_account or private.', - 'type' => 'string', - 'example' => 'yourAccessKeyID', - 'title' => '', - ], - 'SecretKey' => [ - 'description' => 'The SecretKey required when AuthType is set to private_cross_account or private.', - 'type' => 'string', - 'example' => 'yourAccessKeySecret', - 'title' => '', - ], - 'Version' => [ - 'description' => 'The signature version required when the origin is an AWS S3.', - 'type' => 'string', - 'example' => 'v4', - 'title' => '', - ], - 'Region' => [ - 'description' => 'The source Region to be passed when the origin is AWS S3.', - 'type' => 'string', - 'example' => 'us-east-1'."\n", - 'title' => '', - ], + 'AuthType' => ['description' => 'The authentication type.'."\n" + ."\n" + .'- public: Public access. For OSS or S3 origins with public read access.'."\n" + ."\n" + .'- private\\_same\\_account: Private, same account. For private OSS origins in the same account.'."\n" + ."\n" + .'- private\\_cross\\_account: Private, cross-account. For private OSS origins in a different account.'."\n" + ."\n" + .'- private: Private. For private S3 origins.', 'type' => 'string', 'example' => 'public', 'title' => ''], + 'AccessKey' => ['description' => 'The AccessKey ID. This parameter is required if `AuthType` is set to `private_cross_account` or `private`.', 'type' => 'string', 'example' => 'yourAccessKeyID', 'title' => ''], + 'SecretKey' => ['description' => 'The AccessKey secret. This parameter is required if `AuthType` is set to `private_cross_account` or `private`.', 'type' => 'string', 'example' => 'yourAccessKeySecret', 'title' => ''], + 'Version' => ['description' => 'The signature version. Required if the origin is an AWS S3 bucket.', 'type' => 'string', 'example' => 'v4', 'title' => ''], + 'Region' => ['description' => 'The AWS Region of the origin. Required if the origin is an AWS S3 bucket.', 'type' => 'string', 'example' => 'us-east-1'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], - 'IpVersionPolicy' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'IpVersionPolicy' => ['description' => 'The IP version policy for origin requests.'."\n" + ."\n" + .'- round\\_robin: Default policy. Routes requests to IPv4 and IPv6 origins on a round-robin basis.'."\n" + ."\n" + .'- ipv4\\_first: Prioritizes IPv4. Routes requests to IPv4 origins first.'."\n" + ."\n" + .'- ipv6\\_first: Prioritizes IPv6. Routes requests to IPv6 origins first.'."\n" + ."\n" + .'- follow: Matches the client\'s IP version. The origin request uses the same IP version as the incoming request.', 'type' => 'string', 'example' => 'round_robin', 'title' => ''], ], 'title' => '', 'example' => '', @@ -45812,42 +25962,24 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'OriginPoolNotExist', - 'errorMessage' => 'The specified origin pool does not exist or does not belong to your account or website. Check and try again.', - 'description' => 'The specified origin pool does not exist or does not belong to your account or website. Check and try again.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'OriginPoolNotExist', 'errorMessage' => 'The specified origin pool does not exist or does not belong to your account or website. Check and try again.', 'description' => 'The specified origin pool does not exist or does not belong to your account or website. Check and try again.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], + '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\\": \\"round_robin\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Query a Single Origin Pool', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetOriginPool', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOriginPool'], ], ], 'ramActions' => [ @@ -45858,25 +25990,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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', - ], + 'summary' => 'Queries site origin protection configurations, including the origin protection switch, the origin convergence switch, whether the origin IP whitelist needs to be updated, and detailed information about the origin IP whitelist, including the current origin IP whitelist used by the site, the latest origin IP whitelist, and the differences between them.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -45889,62 +26012,38 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '250109', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4VDL9A', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4VDL9A'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID. You can call the [ListSites](~~2850189~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'], 'CurrentIPWhitelist' => [ - 'description' => 'The IP whitelist for origin protection used by the website.'."\n", + 'description' => 'The current origin IP whitelist used by the site.', 'type' => 'object', 'properties' => [ 'IPv4' => [ - 'description' => 'The IP whitelist for origin protection used by the website, specified as IPv4 addresses or CIDR blocks.'."\n", + 'description' => 'The current origin IP whitelist used by the site, IPv4 addresses or CIDR blocks.', 'type' => 'array', - 'items' => [ - 'description' => 'The IPv4 address or CIDR block.'."\n", - 'type' => 'string', - 'example' => '101.66.250.0/25', - 'title' => '', - ], + 'items' => ['description' => 'IPv4 address or CIDR block.', 'type' => 'string', 'example' => '101.66.250.0/25', 'title' => ''], 'title' => '', 'example' => '', ], 'IPv6' => [ - 'description' => 'The IP whitelist for origin protection used by the website, specified as IPv6 addresses or CIDR blocks.'."\n", + 'description' => 'The current origin IP whitelist used by the site, IPv6 addresses or CIDR blocks.', 'type' => 'array', - 'items' => [ - 'description' => 'The IPv6 address or CIDR block.'."\n", - 'type' => 'string', - 'example' => '2409:8c54:1841:200a::/64', - 'title' => '', - ], + 'items' => ['description' => 'IPv6 address or CIDR block.', 'type' => 'string', 'example' => '2409:8c54:1841:200a::/64', 'title' => ''], 'title' => '', 'example' => '', ], @@ -45953,30 +26052,20 @@ 'example' => '', ], 'LatestIPWhitelist' => [ - 'description' => 'The latest IP whitelist for origin protection.'."\n", + 'description' => 'The latest origin IP whitelist.', 'type' => 'object', 'properties' => [ 'IPv4' => [ - 'description' => 'The latest IP whitelist for origin protection, specified as IPv4 addresses or CIDR blocks.'."\n", + 'description' => 'The latest origin IP whitelist, IPv4 addresses or CIDR blocks.', 'type' => 'array', - 'items' => [ - 'description' => 'The IPv4 address or CIDR block.'."\n", - 'type' => 'string', - 'example' => '101.66.250.0/25', - 'title' => '', - ], + 'items' => ['description' => 'IPv4 address or CIDR block.', 'type' => 'string', 'example' => '101.66.250.0/25', 'title' => ''], 'title' => '', 'example' => '', ], 'IPv6' => [ - 'description' => 'The latest IP whitelist for origin protection, specified as IPv6 addresses or CIDR blocks.'."\n", + 'description' => 'The latest origin IP whitelist, IPv6 addresses or CIDR blocks.', 'type' => 'array', - 'items' => [ - 'description' => 'The IPv6 address or CIDR block.'."\n", - 'type' => 'string', - 'example' => '2409:8c54:1841:200a::/64', - 'title' => '', - ], + 'items' => ['description' => 'IPv6 address or CIDR block.', 'type' => 'string', 'example' => '2409:8c54:1841:200a::/64', 'title' => ''], 'title' => '', 'example' => '', ], @@ -45985,34 +26074,24 @@ 'example' => '', ], 'DiffIPWhitelist' => [ - 'description' => 'The IP whitelist for origin protection that has been updated.'."\n", + 'description' => 'The changed origin IP whitelist.', 'type' => 'object', 'properties' => [ 'AddedIPWhitelist' => [ - 'description' => 'The new IP whitelist for origin protection.'."\n", + 'description' => 'The added origin IP whitelist entries.', 'type' => 'object', 'properties' => [ 'IPv4' => [ - 'description' => 'The IP whitelist for origin protection, specified as IPv4 addresses or CIDR blocks.'."\n", + 'description' => 'Origin IP whitelist, IPv4 addresses or CIDR blocks.', 'type' => 'array', - 'items' => [ - 'description' => 'The IPv4 address or CIDR block.'."\n", - 'type' => 'string', - 'example' => '101.66.250.0/25', - 'title' => '', - ], + 'items' => ['description' => 'IPv4 address or CIDR block.', 'type' => 'string', 'example' => '101.66.250.0/25', 'title' => ''], 'title' => '', 'example' => '', ], 'IPv6' => [ - 'description' => 'The IP whitelist for origin protection, specified as IPv6 addresses or CIDR blocks.'."\n", + 'description' => 'Origin IP whitelist, IPv6 addresses or CIDR blocks.', 'type' => 'array', - 'items' => [ - 'description' => 'The IPv6 address or CIDR block.'."\n", - 'type' => 'string', - 'example' => '2409:8c54:1841:200a::/64', - 'title' => '', - ], + 'items' => ['description' => 'IPv6 address or CIDR block.', 'type' => 'string', 'example' => '2409:8c54:1841:200a::/64', 'title' => ''], 'title' => '', 'example' => '', ], @@ -46021,30 +26100,20 @@ 'example' => '', ], 'NoChangeIpWhitelist' => [ - 'description' => 'The IP whitelist for origin protection that remains unchanged.'."\n", + 'description' => 'The unchanged origin IP whitelist entries.', 'type' => 'object', 'properties' => [ 'IPv4' => [ - 'description' => 'The IP whitelist for origin protection, specified as IPv4 addresses or CIDR blocks.'."\n", + 'description' => 'Origin IP whitelist, IPv4 addresses or CIDR blocks.', 'type' => 'array', - 'items' => [ - 'description' => 'The IPv4 address or CIDR block.'."\n", - 'type' => 'string', - 'example' => '101.66.250.0/25', - 'title' => '', - ], + 'items' => ['description' => 'IPv4 address or CIDR block.', 'type' => 'string', 'example' => '101.66.250.0/25', 'title' => ''], 'title' => '', 'example' => '', ], 'IPv6' => [ - 'description' => 'The IP whitelist for origin protection, specified as IPv6 addresses or CIDR blocks.'."\n", + 'description' => 'Origin IP whitelist, IPv6 addresses or CIDR blocks.', 'type' => 'array', - 'items' => [ - 'description' => 'The IPv6 address or CIDR block.'."\n", - 'type' => 'string', - 'example' => '2409:8c54:1841:200a::/64', - 'title' => '', - ], + 'items' => ['description' => 'IPv6 address or CIDR block.', 'type' => 'string', 'example' => '2409:8c54:1841:200a::/64', 'title' => ''], 'title' => '', 'example' => '', ], @@ -46053,30 +26122,20 @@ 'example' => '', ], 'RemovedIPWhitelist' => [ - 'description' => 'The IP whitelist for origin protection that has been deleted.'."\n", + 'description' => 'The removed origin IP whitelist entries.', 'type' => 'object', 'properties' => [ 'IPv4' => [ - 'description' => 'The IP whitelist for origin protection, specified as IPv4 addresses or CIDR blocks.'."\n", + 'description' => 'Origin IP whitelist, IPv4 addresses or CIDR blocks.', 'type' => 'array', - 'items' => [ - 'description' => 'The IPv4 address or CIDR block.'."\n", - 'type' => 'string', - 'example' => '101.66.250.0/25', - 'title' => '', - ], + 'items' => ['description' => 'IPv4 address or CIDR block.', 'type' => 'string', 'example' => '101.66.250.0/25', 'title' => ''], 'title' => '', 'example' => '', ], 'IPv6' => [ - 'description' => 'The IP whitelist for origin protection, specified as IPv6 addresses or CIDR blocks.'."\n", + 'description' => 'Origin IP whitelist, IPv6 addresses or CIDR blocks.', 'type' => 'array', - 'items' => [ - 'description' => 'The IPv6 address or CIDR block.'."\n", - 'type' => 'string', - 'example' => '2409:8c54:1841:200a::/64', - 'title' => '', - ], + 'items' => ['description' => 'IPv6 address or CIDR block.', 'type' => 'string', 'example' => '2409:8c54:1841:200a::/64', 'title' => ''], 'title' => '', 'example' => '', ], @@ -46089,57 +26148,43 @@ 'example' => '', ], 'RegionalCurrentIPWhitelist' => [ - 'description' => 'The regional back-to-origin IP whitelist currently used by the site.', - 'title' => 'The regional back-to-origin IP whitelist currently used by the site.', + 'title' => '', + 'description' => 'The regional origin IP whitelist currently used by the site.', 'type' => 'object', 'properties' => [ 'RegionalIPv4' => [ - 'description' => 'The regional back-to-origin IP whitelist currently used by the site, including IPv4 CIDR blocks and areas.', - 'title' => 'The regional back-to-origin IP whitelist currently used by the site, including IPv4 CIDR blocks and areas.', + 'title' => '', + 'description' => 'The regional origin IP whitelist currently used by the site, IPv4 CIDR blocks and regions.', 'type' => 'array', 'items' => [ - 'description' => 'An IPv4 CIDR block and an area.', - 'title' => 'An IPv4 CIDR block and an area.', + 'title' => '', + 'description' => 'IPv4 CIDR block and region.', 'type' => 'object', 'properties' => [ - 'Cidr' => [ - 'description' => 'An IPv4 CIDR block.', - 'title' => 'An IPv4 CIDR block.', - 'type' => 'string', - 'example' => '101.66.250.0/25', - ], - 'Region' => [ - 'description' => 'An IPv4 area.', - 'title' => 'An IPv4 area.', - 'type' => 'string', - 'example' => 'chinese_mainland', - ], + 'Cidr' => ['title' => '', 'description' => 'IPv4 CIDR block.', 'type' => 'string', 'example' => '101.66.250.0/25'], + 'Region' => ['title' => '', 'description' => 'IPv4 region. Valid values:'."\n" + ."\n" + .'- chinese_mainland: Chinese mainland.'."\n" + .'- global_excluding_chinese_mainland: Global (excluding Chinese mainland).', 'type' => 'string', 'example' => 'chinese_mainland'], ], 'example' => '', ], 'example' => '', ], 'RegionalIPv6' => [ - 'description' => 'The regional back-to-origin IP whitelist currently used by the site, including IPv6 CIDR blocks and areas.', - 'title' => 'The regional back-to-origin IP whitelist currently used by the site, including IPv6 CIDR blocks and areas.', + 'title' => '', + 'description' => 'The regional origin IP whitelist currently used by the site, IPv6 CIDR blocks and regions.', 'type' => 'array', 'items' => [ - 'description' => 'IPv6 CIDR block and area.', - 'title' => 'IPv6 CIDR block and area.', + 'title' => '', + 'description' => 'IPv6 CIDR block and region.', 'type' => 'object', 'properties' => [ - 'Cidr' => [ - 'description' => 'IPv6 CIDR block.', - 'title' => 'IPv6 CIDR block.', - 'type' => 'string', - 'example' => '101.66.250.0/25', - ], - 'Region' => [ - 'description' => 'IPv6 area.', - 'title' => 'IPv6 area.', - 'type' => 'string', - 'example' => 'chinese_mainland', - ], + 'Cidr' => ['title' => '', 'description' => 'IPv6 CIDR block.', 'type' => 'string', 'example' => '101.66.250.0/25'], + 'Region' => ['title' => '', 'description' => 'IPv6 region. Valid values:'."\n" + ."\n" + .'- chinese_mainland: Chinese mainland.'."\n" + .'- global_excluding_chinese_mainland: Global (excluding Chinese mainland).', 'type' => 'string', 'example' => 'chinese_mainland'], ], 'example' => '', ], @@ -46149,59 +26194,43 @@ 'example' => '', ], 'RegionalLatestIPWhitelist' => [ - 'description' => 'The latest regional back-to-origin IP whitelist. ', - 'title' => 'The latest regional back-to-origin IP whitelist. ', + 'title' => '', + 'description' => 'The latest regional origin IP whitelist.', 'type' => 'object', 'properties' => [ 'RegionalIPv4' => [ - 'description' => 'The latest regional back-to-origin IP whitelist, including IPv4 CIDR blocks and areas. '."\n", - 'title' => 'The latest regional back-to-origin IP whitelist, including IPv4 CIDR blocks and areas. '."\n", + 'title' => '', + 'description' => 'The latest regional origin IP whitelist, IPv4 CIDR blocks and regions.', 'type' => 'array', 'items' => [ - 'description' => 'IPv4 CIDR block and area.', - 'title' => 'IPv4 CIDR block, area.', + 'title' => '', + 'description' => 'IPv4 CIDR block and region.', 'type' => 'object', 'properties' => [ - 'Cidr' => [ - 'description' => 'IPv4 CIDR block.', - 'title' => 'IPv4 CIDR block.', - 'type' => 'string', - 'example' => '101.66.250.0/25', - ], - 'Region' => [ - 'description' => 'IPv4 area.', - 'title' => 'IPv4 area.', - 'type' => 'string', - 'example' => 'chinese_mainland', - ], + 'Cidr' => ['title' => '', 'description' => 'IPv4 CIDR block.', 'type' => 'string', 'example' => '101.66.250.0/25'], + 'Region' => ['title' => '', 'description' => 'IPv4 region. Valid values:'."\n" + ."\n" + .'- chinese_mainland: Chinese mainland.'."\n" + .'- global_excluding_chinese_mainland: Global (excluding Chinese mainland).', 'type' => 'string', 'example' => 'chinese_mainland'], ], 'example' => '', ], 'example' => '', ], 'RegionalIPv6' => [ - 'description' => 'The latest regional back-to-origin IP whitelist, including IPv6 CIDR blocks and areas.'."\n" - ."\n", - 'title' => 'The latest regional back-to-origin IP whitelist, including IPv6 CIDR blocks and areas.'."\n" - ."\n", + 'title' => '', + 'description' => 'The latest regional origin IP whitelist, IPv6 CIDR blocks and regions.', 'type' => 'array', 'items' => [ - 'description' => 'IPv6 CIDR block, area.', - 'title' => 'IPv6 CIDR block, area.', + 'title' => '', + 'description' => 'IPv6 CIDR block and region.', 'type' => 'object', 'properties' => [ - 'Cidr' => [ - 'description' => 'IPv6 CIDR block.', - 'title' => 'IPv6 CIDR block.', - 'type' => 'string', - 'example' => '101.66.250.0/25', - ], - 'Region' => [ - 'description' => 'IPv6 area. ', - 'title' => 'IPv6 area. ', - 'type' => 'string', - 'example' => 'chinese_mainland', - ], + 'Cidr' => ['title' => '', 'description' => 'IPv6 CIDR block.', 'type' => 'string', 'example' => '101.66.250.0/25'], + 'Region' => ['title' => '', 'description' => 'IPv6 region. Valid values:'."\n" + ."\n" + .'- chinese_mainland: Chinese mainland.'."\n" + .'- global_excluding_chinese_mainland: Global (excluding Chinese mainland).', 'type' => 'string', 'example' => 'chinese_mainland'], ], 'example' => '', ], @@ -46211,64 +26240,48 @@ 'example' => '', ], 'RegionalDiffIPWhitelist' => [ - 'description' => 'Regional back-to-origin IP whitelist with changes.', - 'title' => 'Regional back-to-origin IP whitelist with changes.', + 'title' => '', + 'description' => 'The changed regional origin IP whitelist.', 'type' => 'object', 'properties' => [ 'AddedIPRegionWhitelist' => [ - 'description' => 'Added regional back-to-origin IP whitelist.', - 'title' => 'Added regional back-to-origin IP whitelist.', + 'title' => '', + 'description' => 'The added regional origin IP whitelist entries.', 'type' => 'object', 'properties' => [ 'RegionalIPv4' => [ - 'description' => 'Regional back-to-origin IP whitelist, including IPv4 CIDR blocks and areas.', - 'title' => 'Regional back-to-origin IP whitelist, including IPv4 CIDR blocks and areas.', + 'title' => '', + 'description' => 'Regional origin IP whitelist, IPv4 CIDR blocks and regions.', 'type' => 'array', 'items' => [ - 'description' => 'IPv4 CIDR block and area.', - 'title' => 'IPv4 CIDR block and area.', + 'title' => '', + 'description' => 'IPv4 CIDR block and region.', 'type' => 'object', 'properties' => [ - 'Cidr' => [ - 'description' => 'IPv4 CIDR block.', - 'title' => 'IPv4 CIDR block.', - 'type' => 'string', - 'example' => '101.66.250.0/25', - ], - 'Region' => [ - 'description' => 'IPv4 area.', - 'title' => 'IPv4 area.', - 'type' => 'string', - 'example' => 'chinese_mainland', - ], + 'Cidr' => ['title' => '', 'description' => 'IPv4 CIDR block.', 'type' => 'string', 'example' => '101.66.250.0/25'], + 'Region' => ['title' => '', 'description' => 'IPv4 region. Valid values:'."\n" + ."\n" + .'- chinese_mainland: Chinese mainland.'."\n" + .'- global_excluding_chinese_mainland: Global (excluding Chinese mainland).', 'type' => 'string', 'example' => 'chinese_mainland'], ], 'example' => '', ], 'example' => '', ], 'RegionalIPv6' => [ - 'description' => 'Regional back-to-origin IP whitelist, including IPv6 CIDR blocks and areas.'."\n" - ."\n", - 'title' => 'Regional back-to-origin IP whitelist, including IPv6 CIDR blocks and areas.'."\n" - ."\n", + 'title' => '', + 'description' => 'Regional origin IP whitelist, IPv6 CIDR blocks and regions.', 'type' => 'array', 'items' => [ - 'description' => 'IPv6 CIDR block and area.', - 'title' => 'IPv6 CIDR block and area.', + 'title' => '', + 'description' => 'IPv6 CIDR block and region.', 'type' => 'object', 'properties' => [ - 'Cidr' => [ - 'description' => 'IPv6 CIDR block.', - 'title' => 'IPv6 CIDR block.', - 'type' => 'string', - 'example' => '101.66.250.0/25', - ], - 'Region' => [ - 'description' => 'IPv6 area. ', - 'title' => 'IPv6 area. ', - 'type' => 'string', - 'example' => 'chinese_mainland', - ], + 'Cidr' => ['title' => '', 'description' => 'IPv6 CIDR block.', 'type' => 'string', 'example' => '101.66.250.0/25'], + 'Region' => ['title' => '', 'description' => 'IPv6 region. Valid values:'."\n" + ."\n" + .'- chinese_mainland: Chinese mainland.'."\n" + .'- global_excluding_chinese_mainland: Global (excluding Chinese mainland).', 'type' => 'string', 'example' => 'chinese_mainland'], ], 'example' => '', ], @@ -46278,57 +26291,43 @@ 'example' => '', ], 'NoChangeIpWhitelist' => [ - 'description' => 'Regional back-to-origin IP whitelist with no changes. ', - 'title' => 'Regional back-to-origin IP whitelist with no changes. ', + 'title' => '', + 'description' => 'The unchanged regional origin IP whitelist entries.', 'type' => 'object', 'properties' => [ 'RegionalIPv4' => [ - 'description' => 'Regional back-to-origin IP whitelist, IPv4 CIDR block and area. ', - 'title' => 'Regional back-to-origin IP whitelist, IPv4 CIDR block and area. ', + 'title' => '', + 'description' => 'Regional origin IP whitelist, IPv4 CIDR blocks and regions.', 'type' => 'array', 'items' => [ - 'description' => 'IPv4 CIDR block and area. ', - 'title' => 'IPv4 CIDR block and area. ', + 'title' => '', + 'description' => 'IPv4 CIDR block and region.', 'type' => 'object', 'properties' => [ - 'Cidr' => [ - 'description' => 'IPv4 CIDR block. ', - 'title' => 'IPv4 CIDR block.', - 'type' => 'string', - 'example' => '101.66.250.0/25', - ], - 'Region' => [ - 'description' => 'IPv4 area.', - 'title' => 'IPv4 area.', - 'type' => 'string', - 'example' => 'chinese_mainland', - ], + 'Cidr' => ['title' => '', 'description' => 'IPv4 CIDR block.', 'type' => 'string', 'example' => '101.66.250.0/25'], + 'Region' => ['title' => '', 'description' => 'IPv4 region. Valid values:'."\n" + ."\n" + .'- chinese_mainland: Chinese mainland.'."\n" + .'- global_excluding_chinese_mainland: Global (excluding Chinese mainland).', 'type' => 'string', 'example' => 'chinese_mainland'], ], 'example' => '', ], 'example' => '', ], 'RegionalIPv6' => [ - 'description' => 'Regional back-to-origin IP whitelist, IPv6 CIDR block and area.', - 'title' => 'Regional back-to-origin IP whitelist, IPv6 CIDR block and area.', + 'title' => '', + 'description' => 'Regional origin IP whitelist, IPv6 CIDR blocks and regions.', 'type' => 'array', 'items' => [ - 'description' => 'IPv6 CIDR block and area.', - 'title' => 'IPv6 CIDR block and area.', + 'title' => '', + 'description' => 'IPv6 CIDR block and region.', 'type' => 'object', 'properties' => [ - 'Cidr' => [ - 'description' => 'IPv6 CIDR block.', - 'title' => 'IPv6 CIDR block.', - 'type' => 'string', - 'example' => '101.66.250.0/25', - ], - 'Region' => [ - 'description' => 'IPv6 area. ', - 'title' => 'IPv6 area. ', - 'type' => 'string', - 'example' => 'chinese_mainland', - ], + 'Cidr' => ['title' => '', 'description' => 'IPv6 CIDR block.', 'type' => 'string', 'example' => '101.66.250.0/25'], + 'Region' => ['title' => '', 'description' => 'IPv6 region. Valid values:'."\n" + ."\n" + .'- chinese_mainland: Chinese mainland.'."\n" + .'- global_excluding_chinese_mainland: Global (excluding Chinese mainland).', 'type' => 'string', 'example' => 'chinese_mainland'], ], 'example' => '', ], @@ -46338,62 +26337,49 @@ 'example' => '', ], 'RemovedIPRegionWhitelist' => [ - 'description' => 'Deleted regional back-to-origin IP whitelist. ', - 'title' => 'Deleted regional back-to-origin IP whitelist. ', + 'title' => '', + 'description' => 'The removed regional origin IP whitelist entries.', 'type' => 'object', 'properties' => [ 'RegionalIPv4' => [ - 'description' => 'Regional back-to-origin IP whitelist, IPv4 CIDR block and area. ', - 'title' => 'Regional back-to-origin IP whitelist, IPv4 CIDR block and area. ', + 'title' => '', + 'description' => 'Regional origin IP whitelist, IPv4 CIDR blocks and regions.', 'type' => 'array', 'items' => [ - 'description' => 'IPv4 CIDR block and area. ', - 'title' => 'IPv4 CIDR block and area. ', + 'title' => '', + 'description' => 'IPv4 CIDR block and region.', 'type' => 'object', 'properties' => [ - 'Cidr' => [ - 'description' => 'IPv4 CIDR block. ', - 'title' => 'IPv4 CIDR block.', - 'type' => 'string', - 'example' => '101.66.250.0/25', - ], - 'Region' => [ - 'description' => 'IPv4 area.', - 'title' => 'IPv4 area.', - 'type' => 'string', - 'example' => 'chinese_mainland', - ], + 'Cidr' => ['title' => '', 'description' => 'IPv4 CIDR block.', 'type' => 'string', 'example' => '101.66.250.0/25'], + 'Region' => ['title' => '', 'description' => 'IPv4 region. Valid values:'."\n" + ."\n" + .'- chinese_mainland: Chinese mainland.'."\n" + .'- global_excluding_chinese_mainland: Global (excluding Chinese mainland).', 'type' => 'string', 'example' => 'chinese_mainland'], ], 'example' => '', ], 'example' => '', ], 'RegionalIPv6' => [ - 'description' => 'Regional back-to-origin IP whitelist, including IPv6 CIDR blocks and areas.'."\n" - ."\n", - 'title' => 'Regional back-to-origin IP whitelist, including IPv6 CIDR blocks and areas.'."\n" - ."\n", + 'title' => '', + 'description' => 'Regional origin IP whitelist, IPv6 CIDR blocks and regions.', 'type' => 'array', 'items' => [ - 'description' => 'IPv6 CIDR block and area.', - 'title' => 'IPv6 CIDr block and area.', + 'title' => '', + 'description' => 'IPv6 CIDR block and region.', 'type' => 'object', 'properties' => [ - 'Cidr' => [ - 'description' => 'IPv6 CIDR block.', - 'title' => 'IPv6 CIDR block.', - 'type' => 'string', - 'example' => '101.66.250.0/25', - ], + 'Cidr' => ['title' => '', 'description' => 'IPv6 CIDR block.', 'type' => 'string', 'example' => '101.66.250.0/25'], 'Region' => [ - 'description' => 'IPv6 area. ', - 'title' => 'IPv6 area. ', + 'title' => '', + 'description' => 'IPv6 region. Valid values:'."\n" + ."\n" + .'- chinese_mainland: Chinese mainland.'."\n" + .'- global_excluding_chinese_mainland: Global (excluding Chinese mainland).', + 'enumValueTitles' => ['global_excluding_chinese_mainland' => 'Global (excluding Chinese mainland)', 'chinese_mainland' => 'Chinese mainland'], 'type' => 'string', 'example' => 'chinese_mainland', - 'enum' => [ - 'chinese_mainland', - 'global_excluding_chinese_mainland', - ], + 'enum' => ['chinese_mainland', 'global_excluding_chinese_mainland'], ], ], 'example' => '', @@ -46406,79 +26392,44 @@ ], 'example' => '', ], - 'NeedUpdate' => [ - 'description' => 'Indicates whether the IP whitelist for origin protection needs to be updated. If the currently used IP whitelist is different from the latest IP whitelist, it needs to be updated, and the value is true.'."\n" - ."\n" - .'* true: The update is required.'."\n" - .'* false: No update is required.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], - 'OriginProtection' => [ - 'description' => 'Indicates whether origin protection is enabled.'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'OriginConverge' => [ - 'description' => 'Indicates whether IP convergence is enabled.'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456****', - 'title' => '', - ], - 'AutoConfirmIPList' => [ - 'description' => 'Automatically enable the latest back-to-origin IP addresses list. ', - 'title' => 'Automatically enable the latest back-to-origin IP addresses list. ', - 'type' => 'string', - 'example' => 'off', - ], + 'NeedUpdate' => ['description' => 'Indicates whether the origin IP whitelist needs to be updated. When the current origin IP whitelist differs from the latest origin IP whitelist, an update is needed and this value returns true.'."\n" + ."\n" + .'- true: Update is needed.'."\n" + .'- false: No update is needed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'OriginProtection' => ['description' => 'Origin protection switch:'."\n" + ."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'OriginConverge' => ['description' => 'Origin convergence switch:'."\n" + ."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'SiteId' => ['description' => 'Site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456****', 'title' => ''], + 'AutoConfirmIPList' => ['title' => '', 'description' => 'Automatically enable the latest origin IP list.', 'type' => 'string', 'example' => 'off'], ], 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'Obtain origin protection information', - 'summary' => 'Query the site\'s origin protection configuration, including the origin protection toggle, origin fetch convergence toggle, whether an update to the back-to-origin IP whitelist is required, and detailed information about the back-to-origin IP whitelist, including the currently used back-to-origin IP whitelist for the site, the latest back-to-origin IP whitelist, and the differences between the two.', + 'staticInfo' => ['returnType' => 'synchronous'], + '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"}]', + 'title' => 'GetOriginProtection', 'changeSet' => [ - [ - 'createdAt' => '2024-12-24T01:42:33.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2024-12-24T01:42:33.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '20', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetOriginProtection', - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOriginProtection'], ], ], 'ramActions' => [ @@ -46489,26 +26440,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => 'Queries the configurations of a single origin rule.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -46521,34 +26462,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257604', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '3400350********', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '3400350********', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the configuration. You can call the [ListSiteRoutes](~~2866989~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '33793140540****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the configuration. You can call the [ListSiteRoutes](~~2866989~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '33793140540****', 'title' => ''], ], ], 'responses' => [ @@ -46558,231 +26483,87 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.'."\n", - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - ], - 'ConfigId' => [ - 'description' => 'The configuration ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '352816096987136', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'The configuration type to query. Valid values:'."\n" - ."\n" - .'* global: global configurations.'."\n" - .'* rule: rule configurations.'."\n", - 'type' => 'string', - 'example' => 'rule', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'The version number of the configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'The rule execution order. The smaller the value, the higher the priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:'."\n" - ."\n" - .'* true: Match all incoming requests.'."\n" - .'* Set the value to a custom expression, for example, (http.host eq "video.example.com"): Match the specified request.'."\n", - 'type' => 'string', - 'example' => '(http.host eq \\"video.example.com\\")'."\n", - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'The rule name. You do not need to set this parameter when you add global configurations.'."\n", - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], - 'OriginHost' => [ - 'description' => 'The Host header in origin requests.'."\n", - 'type' => 'string', - 'example' => 'origin.example.com'."\n", - 'title' => '', - ], - 'OriginScheme' => [ - 'description' => 'The protocol used for origin requests. Valid values:'."\n" - ."\n" - .'* http: HTTP.'."\n" - .'* https: HTTPS.'."\n" - .'* follow: follows the protocol used by the client.'."\n", - 'type' => 'string', - 'example' => 'http', - 'title' => '', - ], - 'OriginSni' => [ - 'description' => 'The SNI in origin requests.'."\n", - 'type' => 'string', - 'example' => 'origin.example.com'."\n", - 'title' => '', - ], - 'DnsRecord' => [ - 'description' => 'The hostname that overrides the resolved hostname of an incoming request.'."\n", - 'type' => 'string', - 'example' => 'test.example.com'."\n", - 'title' => '', - ], - 'OriginHttpPort' => [ - 'description' => 'The origin port that is accessed when the HTTP protocol is used to back to the origin.'."\n", - 'type' => 'string', - 'example' => '8080', - 'title' => '', - ], - 'OriginHttpsPort' => [ - 'description' => 'The origin port that is accessed when the HTTPS protocol is used to back to the origin.'."\n", - 'type' => 'string', - 'example' => '4433', - 'title' => '', - ], - 'Range' => [ - 'description' => 'Use range requests to download an object from the source. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n" - .'* force: enables range origin fetch by force.'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'OriginMtls' => [ - 'description' => 'The MTLS switch. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'OriginVerify' => [ - 'description' => 'The origin certificate verification switch. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'RangeChunkSize' => [ - 'description' => 'The size of the range part. Valid values:'."\n" - ."\n" - .'* 512KB'."\n" - .'* 1MB'."\n" - .'* 2MB'."\n" - .'* 4MB'."\n", - 'type' => 'string', - 'example' => '1MB', - 'title' => '', - ], - 'OriginReadTimeout' => [ - 'description' => 'The read timeout period (in seconds) on the origin.'."\n", - 'type' => 'string', - 'example' => '10', - 'title' => '', - ], - 'Follow302Enable' => [ - 'description' => '302 follow switch. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Follow302MaxTries' => [ - 'description' => 'The maximum number of 302 follow times. Valid values: 1 to 5.'."\n", - 'type' => 'string', - 'example' => '1', - 'title' => '', - ], - 'Follow302RetainArgs' => [ - 'description' => 'Retains the original request parameters switch. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Follow302RetainHeader' => [ - 'description' => 'Retain the original request header switch. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Follow302TargetHost' => [ - 'description' => 'Target Host'."\n", - 'type' => 'string', - 'example' => 'test.com', - 'title' => '', - ], - ], - 'example' => '', - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.'."\n", 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'], + 'ConfigId' => ['description' => 'The configuration ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '352816096987136', 'title' => ''], + 'ConfigType' => ['description' => 'The configuration type to query. Valid values:'."\n" + ."\n" + .'* global: global configurations.'."\n" + .'* rule: rule configurations.'."\n", 'type' => 'string', 'example' => 'rule', 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Sequence' => ['description' => 'The rule execution order. The smaller the value, the higher the priority.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuleEnable' => ['description' => 'Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Valid values:'."\n" + ."\n" + .'* on'."\n" + .'* off'."\n", 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:'."\n" + ."\n" + .'* true: Match all incoming requests.'."\n" + .'* Set the value to a custom expression, for example, (http.host eq "video.example.com"): Match the specified request.'."\n", 'type' => 'string', 'example' => '(http.host eq \\"video.example.com\\")'."\n", 'title' => ''], + 'RuleName' => ['description' => 'The rule name. You do not need to set this parameter when you add global configurations.'."\n", 'type' => 'string', 'example' => 'rule_example', 'title' => ''], + 'OriginHost' => ['description' => 'The Host header in origin requests.'."\n", 'type' => 'string', 'example' => 'origin.example.com'."\n", 'title' => ''], + 'OriginScheme' => ['description' => 'The protocol used for origin requests. Valid values:'."\n" + ."\n" + .'* http: HTTP.'."\n" + .'* https: HTTPS.'."\n" + .'* follow: follows the protocol used by the client.'."\n", 'type' => 'string', 'example' => 'http', 'title' => ''], + 'OriginSni' => ['description' => 'The SNI in origin requests.'."\n", 'type' => 'string', 'example' => 'origin.example.com'."\n", 'title' => ''], + 'DnsRecord' => ['description' => 'The hostname that overrides the resolved hostname of an incoming request.'."\n", 'type' => 'string', 'example' => 'test.example.com'."\n", 'title' => ''], + 'OriginHttpPort' => ['description' => 'The origin port that is accessed when the HTTP protocol is used to back to the origin.'."\n", 'type' => 'string', 'example' => '8080', 'title' => ''], + 'OriginHttpsPort' => ['description' => 'The origin port that is accessed when the HTTPS protocol is used to back to the origin.'."\n", 'type' => 'string', 'example' => '4433', 'title' => ''], + 'Range' => ['description' => 'Use range requests to download an object from the source. Valid values:'."\n" + ."\n" + .'* on'."\n" + .'* off'."\n" + .'* force: enables range origin fetch by force.'."\n", 'type' => 'string', 'example' => 'on', 'title' => ''], + 'OriginMtls' => ['description' => 'The MTLS switch. Valid values:'."\n" + ."\n" + .'* on'."\n" + .'* off'."\n", 'type' => 'string', 'example' => 'on', 'title' => ''], + 'OriginVerify' => ['description' => 'The origin certificate verification switch. Valid values:'."\n" + ."\n" + .'* on'."\n" + .'* off'."\n", 'type' => 'string', 'example' => 'on', 'title' => ''], + 'RangeChunkSize' => ['description' => 'The size of the range part. Valid values:'."\n" + ."\n" + .'* 512KB'."\n" + .'* 1MB'."\n" + .'* 2MB'."\n" + .'* 4MB'."\n", 'type' => 'string', 'example' => '1MB', 'title' => ''], + 'OriginReadTimeout' => ['description' => 'The read timeout period (in seconds) on the origin.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], + 'Follow302Enable' => ['description' => '302 follow switch. Valid values:'."\n" + ."\n" + .'* on'."\n" + .'* off'."\n", 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Follow302MaxTries' => ['description' => 'The maximum number of 302 follow times. Valid values: 1 to 5.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'Follow302RetainArgs' => ['description' => 'Retains the original request parameters switch. Valid values:'."\n" + ."\n" + .'* on'."\n" + .'* off'."\n", 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Follow302RetainHeader' => ['description' => 'Retain the original request header switch. Valid values:'."\n" + ."\n" + .'* on'."\n" + .'* off'."\n", 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Follow302TargetHost' => ['description' => 'Target Host'."\n", 'type' => 'string', 'example' => 'test.com', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], 'title' => 'GetOriginRule', 'changeSet' => [ - [ - 'createdAt' => '2025-04-17T08:47:33.000Z', - 'description' => 'Response parameters changed', - ], - [ - 'createdAt' => '2025-04-01T01:57:04.000Z', - 'description' => 'Response parameters changed', - ], - [ - 'createdAt' => '2025-03-20T05:57:46.000Z', - 'description' => 'Response parameters changed', - ], - [ - 'createdAt' => '2025-02-27T09:16:40.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-04-17T08:47:33.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-04-01T01:57:04.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-03-20T05:57:46.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-02-27T09:16:40.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetOriginRule', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOriginRule'], ], ], 'ramActions' => [ @@ -46793,12 +26574,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -46806,14 +26582,9 @@ '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"}]', ], 'GetPage' => [ - 'summary' => 'Queries the details of a custom error page based on the error page ID.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Retrieves the details of a custom response page by its ID.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -46826,96 +26597,41 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239604', - 'abilityTreeNodes' => [ - 'FEATUREdcdnL8HX1L', - ], + 'abilityTreeNodes' => ['FEATUREdcdnL8HX1L'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The ID of the custom error page, which can be obtained by calling the [ListPages](~~2850223~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '50000001', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the custom response page. You can obtain this value by calling the [ListPages](~~2850223~~) operation.', 'type' => 'integer', 'format' => 'int64', 'example' => '50000001', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225 ', - ], - 'UpdateTime' => [ - 'title' => '', - 'description' => 'The time when the custom error page was last modified.'."\n", - 'type' => 'string', - 'example' => '2024-01-01T00:00:00Z', - ], - 'Id' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225 '], + 'UpdateTime' => ['title' => '', 'description' => 'The last modification time of the custom response page.'."\n" + ."\n" + .'Format: RFC 3339 / ISO 8601, UTC time zone (ending with Z).'."\n" + ."\n" + .'Example: 2026-06-10T14:23:45Z', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], + 'Id' => ['title' => '', 'description' => 'The ID of the custom response page. You can obtain this value by calling the [ListPages](~~2850223~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50000001', 'pattern' => '', 'default' => ''], + 'Name' => ['title' => '', 'description' => 'The name of the custom response page.', 'type' => 'string', 'required' => true, 'example' => 'example', 'maxLength' => 128, 'pattern' => '', 'default' => ''], + 'Description' => ['title' => '', 'description' => 'The description of the custom response page.', 'type' => 'string', 'required' => false, 'example' => 'a custom deny page', 'maxLength' => 1024, 'pattern' => '', 'default' => ''], + 'Kind' => ['title' => '', 'description' => 'The type of the custom response page.', 'type' => 'string', 'example' => 'custom'], + 'ContentType' => ['title' => '', 'description' => 'The Content-Type field in the HTTP header.', 'type' => 'string', 'required' => true, 'example' => 'text/html', 'pattern' => '', 'default' => ''], + 'Content' => ['title' => '', 'description' => 'The Base64-encoded response page content corresponding to the Content-Type.', 'type' => 'string', 'required' => true, 'example' => 'PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=', 'pattern' => '', 'default' => ''], + 'SiteIds' => [ 'title' => '', - 'description' => 'The ID of the custom error page.[](~~2850223~~)'."\n", - 'type' => 'integer', + 'description' => 'The list of associated site IDs.', + 'type' => 'array', 'format' => 'int64', - 'required' => false, - 'example' => '50000001', - 'pattern' => '', - 'default' => '', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The name of the custom response page.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'example', - 'maxLength' => 128, - 'pattern' => '', - 'default' => '', - ], - 'Description' => [ - 'title' => '', - 'description' => 'The description of the custom error page.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a custom deny page', - 'maxLength' => 1024, - 'pattern' => '', - 'default' => '', - ], - 'Kind' => [ - 'title' => '', - 'description' => 'The type of the custom response page.'."\n", - 'type' => 'string', - 'example' => 'custom', - ], - 'ContentType' => [ - 'title' => '', - 'description' => 'The Content-Type field in the HTTP header.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'text/html', - 'pattern' => '', - 'default' => '', - ], - 'Content' => [ - 'title' => '', - 'description' => 'The Base64-encoded content of the error page. The content type is specified by the Content-Type field.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=', - 'pattern' => '', - 'default' => '', + 'items' => ['title' => '', 'description' => 'The associated site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'example' => '', ], ], 'example' => '', @@ -46924,37 +26640,23 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The specified parameters are invalid.', - 'description' => 'Parameter is illegal.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The specified parameters are invalid.', 'description' => 'Parameter is illegal.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - '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"}]', - 'title' => 'GetPage', + '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 \\"SiteIds\\": [\\n 1\\n ]\\n}","type":"json"}]', + 'title' => 'Get custom response page details', 'changeSet' => [ - [ - 'createdAt' => '2024-09-25T07:02:48.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-25T07:02:48.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetPage', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPage'], ], ], 'ramActions' => [ @@ -46965,29 +26667,16 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], ], - 'GetPurgeQuota' => [ - 'summary' => 'Queries the quotas and quota usage for different cache purge options.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetPerformanceDataCollection' => [ + 'summary' => 'Queries the data quality collection configuration.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -46999,55 +26688,99 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '239209', - 'abilityTreeNodes' => [ - 'FEATUREdcdnBCJPGN', - 'FEATUREdcdnELTTM1', - 'FEATUREdcdnA9FG2P', - 'FEATUREdcdnRELTJV', - 'FEATUREdcdnEWYS3A', - 'FEATUREdcdn4QVGXU', - 'FEATUREdcdn4TTNAL', - ], + 'abilityTreeCode' => '264794', + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The website ID. You can call the [ListSites](~~2850189~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123456789****', 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229'], + 'Enable' => ['description' => 'Indicates whether quality data collection is enabled. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ], + ], + 'title' => 'Query data quality collection configuration', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPerformanceDataCollection'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetPerformanceDataCollection', + '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 \\"Enable\\": \\"on\\"\\n}","type":"json"}]', + ], + 'GetPurgeQuota' => [ + 'summary' => 'Retrieves the quota and used quota for different refresh types.', + 'methods' => ['get', 'post'], + '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' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], + ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the purge task. Valid values:'."\n" - ."\n" - .'* **file** (default): purges the cache by file.'."\n" - .'* **cachetag**: purges the cache by cache tag.'."\n" - .'* **directory**: purges the cache by directory.'."\n" - .'* **ignoreParams**: purges the cache by URL with specific parameters ignored.'."\n" - .'* **hostname**: purges the cache by hostname.'."\n" - .'* **purgeall**: purges all cache.'."\n", + 'description' => 'The refresh task type. Valid values:'."\n" + .'- **file** (default): file refresh.'."\n" + .'- **cachetag**: cache tag refresh.'."\n" + .'- **directory**: directory refresh.'."\n" + .'- **ignoreParams**: ignore-parameters refresh.'."\n" + .'- **hostname**: hostname refresh.'."\n" + .'- **purgeall**: purge all cache under the site.', + 'enumValueTitles' => ['cachetag' => 'Cache tag refresh.', 'hostname' => 'Hostname refresh.', 'file' => 'File refresh.', 'cachekey' => 'Cache key refresh.', 'purgeall' => 'Purge all cache under the site.', 'ignoreparams' => 'Ignore-parameters refresh.', 'directory' => 'Directory refresh.', 'preload' => 'Prefetch.'], 'type' => 'string', - 'required' => false, + 'required' => true, + 'enum' => ['file', 'cachetag', 'directory', 'ignoreparams', 'hostname', 'purgeall', 'preload', 'cachekey'], 'example' => 'file', - 'enum' => [ - 'file', - 'cachetag', - 'directory', - 'ignoreparams', - 'hostname', - 'purgeall', - 'preload', - 'cachekey', - ], 'title' => '', ], ], @@ -47055,28 +26788,15 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - ], - 'Quota' => [ - 'description' => 'The total quota.'."\n", - 'type' => 'string', - 'example' => '100000', - 'title' => '', - ], - 'Usage' => [ - 'description' => 'The quota usage.'."\n", - 'type' => 'string', - 'example' => '10', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74'], + 'Quota' => ['description' => 'The total quota.', 'type' => 'string', 'example' => '100000', 'title' => ''], + 'Usage' => ['description' => 'The used quota.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'Quota30Day' => ['description' => 'The total quota at 30-day granularity. A value of 0 indicates that this quota is not configured.', 'type' => 'string', 'example' => '200000', 'title' => ''], + 'Usage30Day' => ['description' => 'The used quota at 30-day granularity.', 'type' => 'string', 'example' => '20', 'title' => ''], ], 'example' => '', ], @@ -47084,101 +26804,34 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingTimeParameter', - 'errorMessage' => 'The StartTime and EndTime must be both specified.', - 'description' => 'Please provide both a start time and an end time.', - ], - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], - [ - 'errorCode' => 'DomainNameOverLimit', - 'errorMessage' => 'A maximum of 500 domains are supported for each request.', - 'description' => 'Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.', - ], - [ - 'errorCode' => 'InvalidTime', - 'errorMessage' => 'The query time cannot exceed the last 3 days.', - 'description' => 'The query time cannot exceed the last 3 days.', - ], - [ - 'errorCode' => 'MissingParameter.ObjectType', - 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', - 'description' => 'Specify the ObjectType parameter.', - ], - [ - 'errorCode' => 'InvalidStationParameter', - 'errorMessage' => 'The specified Station is invalid.', - 'description' => 'The specified node parameter is invalid.', - ], - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests.Please try again later.', - 'description' => 'Requests are too frequent, please try again later.', - ], - [ - 'errorCode' => 'InvalidTaskId.Malformed', - 'errorMessage' => 'The specified taskId is invalid.', - 'description' => 'The specified task ID is invalid.', - ], - [ - 'errorCode' => 'InvalidParameters.InvalidUrls', - 'errorMessage' => 'The specified urls are invalid.', - 'description' => 'The requested URL parameter is invalid.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"Quota\\": \\"100000\\",\\n \\"Usage\\": \\"10\\"\\n}","type":"json"}]', - 'title' => 'GetPurgeQuota', - 'changeSet' => [ - [ - 'createdAt' => '2025-02-10T01:55:18.000Z', - 'description' => 'Request parameters changed', + ['errorCode' => 'MissingTimeParameter', 'errorMessage' => 'The StartTime and EndTime must be both specified.', 'description' => 'Please provide both a start time and an end time.'], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'DomainNameOverLimit', 'errorMessage' => 'A maximum of 500 domains are supported for each request.', 'description' => 'Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.'], + ['errorCode' => 'InvalidTime', 'errorMessage' => 'The query time cannot exceed the last 3 days.', 'description' => 'The query time cannot exceed the last 3 days.'], + ['errorCode' => 'MissingParameter.ObjectType', 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', 'description' => 'Specify the ObjectType parameter.'], + ['errorCode' => 'InvalidStationParameter', 'errorMessage' => 'The specified Station is invalid.', 'description' => 'The specified node parameter is invalid.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], + ['errorCode' => 'InvalidTaskId.Malformed', 'errorMessage' => 'The specified taskId is invalid.', 'description' => 'The specified task ID is invalid.'], + ['errorCode' => 'InvalidParameters.InvalidUrls', 'errorMessage' => 'The specified urls are invalid.', 'description' => 'The requested URL parameter is invalid.'], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"Quota\\": \\"100000\\",\\n \\"Usage\\": \\"10\\",\\n \\"Quota30Day\\": \\"200000\\",\\n \\"Usage30Day\\": \\"20\\"\\n}","type":"json"}]', + 'title' => 'Get refresh quota', + 'changeSet' => [ + ['createdAt' => '2025-02-10T01:55:18.000Z', 'description' => 'Request parameters changed'], + ], '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}', - ], - ], - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPurgeQuota'], ], ], + 'ramActions' => [], ], 'GetRealtimeDeliveryField' => [ 'summary' => 'Queries the fields in real-time logs based on the log category.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -47190,27 +26843,19 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239152', - 'abilityTreeNodes' => [ - 'FEATUREdcdn9K10I1', - ], + 'abilityTreeNodes' => ['FEATUREdcdn9K10I1'], ], 'parameters' => [ [ 'name' => 'BusinessType', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '', - 'description' => 'The log category. Valid values:'."\n" - ."\n" - .'* **dcdn_log_access_l1** (default): access logs.'."\n" - .'* **dcdn_log_er**: Edge Routine logs.'."\n" - .'* **dcdn_log_waf**: firewall logs.'."\n" - .'* **dcdn_log_ipa**: TCP/UDP proxy logs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dcdn_log_er', - ], + 'schema' => ['title' => '', 'description' => 'The log category. Valid values:'."\n" + ."\n" + .'* **dcdn_log_access_l1** (default): access logs.'."\n" + .'* **dcdn_log_er**: Edge Routine logs.'."\n" + .'* **dcdn_log_waf**: firewall logs.'."\n" + .'* **dcdn_log_ipa**: TCP/UDP proxy logs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'dcdn_log_er'], ], ], 'responses' => [ @@ -47220,73 +26865,26 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247B78', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247B78'], 'FieldContent' => [ 'description' => 'The fields returned.'."\n", 'type' => 'object', 'additionalProperties' => [ 'type' => 'object', 'properties' => [ - 'SortOrder' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => 'The sequence number of the fields.'."\n", - 'example' => '1', - 'title' => '', - ], + 'SortOrder' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The sequence number of the fields.'."\n", 'example' => '1', 'title' => ''], 'FieldList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'FieldName' => [ - 'type' => 'string', - 'example' => 'ClientIp', - 'description' => 'The field name.'."\n", - 'title' => '', - ], - 'Description' => [ - 'type' => 'string', - 'example' => 'IP address of the client.', - 'description' => 'The description of the field in English.'."\n", - 'title' => '', - ], - 'DescriptionCn' => [ - 'type' => 'string', - 'example' => '客户端的IP地址', - 'description' => 'The description of the field in Chinese.'."\n", - 'title' => '', - ], - 'Category' => [ - 'type' => 'string', - 'description' => 'The category of the field.'."\n", - 'example' => 'Client', - 'title' => '', - ], - 'DataType' => [ - 'type' => 'string', - 'example' => 'String', - 'description' => 'The data type of the field.'."\n", - 'title' => '', - ], - 'SortOrder' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => 'The sequence number of the field.'."\n", - 'example' => '1', - 'title' => '', - ], - 'IsDefault' => [ - 'type' => 'boolean', - 'description' => 'Indicates whether the field is available by default.'."\n", - 'example' => 'true', - 'title' => '', - ], + 'FieldName' => ['type' => 'string', 'example' => 'ClientIp', 'description' => 'The field name.'."\n", 'title' => ''], + 'Description' => ['type' => 'string', 'example' => 'IP address of the client.', 'description' => 'The description of the field in English.'."\n", 'title' => ''], + 'DescriptionCn' => ['type' => 'string', 'example' => '客户端的IP地址', 'description' => 'The description of the field in Chinese.'."\n", 'title' => ''], + 'Category' => ['type' => 'string', 'description' => 'The category of the field.'."\n", 'example' => 'Client', 'title' => ''], + 'DataType' => ['type' => 'string', 'example' => 'String', 'description' => 'The data type of the field.'."\n", 'title' => ''], + 'SortOrder' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The sequence number of the field.'."\n", 'example' => '1', 'title' => ''], + 'IsDefault' => ['type' => 'boolean', 'description' => 'Indicates whether the field is available by default.'."\n", 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', @@ -47311,37 +26909,19 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'GetRealtimeDeliveryField', 'changeSet' => [ - [ - 'createdAt' => '2024-09-27T05:57:03.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-27T05:57:03.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetRealtimeDeliveryField', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRealtimeDeliveryField'], ], ], 'ramActions' => [ @@ -47352,12 +26932,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -47369,12 +26944,9 @@ ], ], 'GetRecord' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Retrieves the detailed configuration of a single DNS record, including the record value, priority, and back-to-origin authentication configuration (exclusive to CNAME records).', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -47387,22 +26959,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239656', - 'abilityTreeNodes' => [ - 'FEATUREdcdnVFT29S', - ], + 'abilityTreeNodes' => ['FEATUREdcdnVFT29S'], ], 'parameters' => [ [ 'name' => 'RecordId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the record, which can be obtained by calling [ListRecords](~~2850265~~). ', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the record. You can obtain this value by calling [ListRecords](~~2850265~~).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], ], 'responses' => [ @@ -47410,284 +26973,96 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => 'F32C57AA-7BF8-49AE-A2CC-9F42390F5A19', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F32C57AA-7BF8-49AE-A2CC-9F42390F5A19'], 'RecordModel' => [ - 'description' => 'The queried single record information.', + 'description' => 'The information about the queried record.', 'type' => 'object', 'properties' => [ - 'BizName' => [ - 'description' => 'The business scenario for record acceleration. Valid values: '."\n" - ."\n" - .'- **image_video**: Image and video. '."\n" - .'- **api**: API. '."\n" - .'- **web**: Web page. ', - 'type' => 'string', - 'example' => 'image_video', - 'title' => '', - ], + 'BizName' => ['description' => 'The business scenario when the record is accelerated. Valid values:'."\n" + ."\n" + .'- **image_video**: video and image.'."\n" + .'- **api**: API.'."\n" + .'- **web**: web page.', 'type' => 'string', 'example' => 'image_video', 'title' => ''], 'Data' => [ - 'description' => 'The DNS information of the record. The content returned in this field varies depending on the record type.', + 'description' => 'The DNS information of the record. The content returned in this field varies by record type.', 'type' => 'object', 'properties' => [ - 'Value' => [ - 'description' => 'The record value or partial content. It has different meanings depending on the record type:'."\n" - ."\n" - .'- **A/AAAA**: The IP address to which the record points. When multiple IP addresses are specified, they must be separated by commas (","). At least one IPv4 address is required.'."\n" - .'- **CNAME**: The target domain name to which the record points.'."\n" - .'- **NS**: The name server designated for the domain.'."\n" - .'- **MX**: A valid domain name of the target mail server.'."\n" - .'- **TXT**: A valid text string.'."\n" - .'- **CAA**: A valid domain name of the certification authority.'."\n" - .'- **SRV**: A valid domain name of the target host.'."\n" - .'- **URI**: A valid URI string.', - 'type' => 'string', - 'example' => 'example.com', - 'title' => '', - ], - 'Priority' => [ - 'description' => 'The priority of the record. The range is **0~65535**. A smaller numeric value indicates a higher priority.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'Flag' => [ - 'description' => 'The flag of the record. For CAA records, the flag indicates priority and processing behavior, with a range of **0~255**.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '128', - 'title' => '', - ], - 'Tags' => [ - 'type' => 'object', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'Weight' => [ - 'description' => 'The weight of the record, with a range of **0~65535**.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Port' => [ - 'description' => 'The port of the record. The range is **0~65535**.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8707', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The certificate type (for CERT records) or public key type (for SSHFP records).', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'RSA', - 'title' => '', - ], - 'KeyTag' => [ - 'description' => 'The public key identity of the record, with a range of **0~65535**.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Algorithm' => [ - 'description' => 'The encryption algorithm used by the record. The range is **0~255**.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Certificate' => [ - 'description' => 'The public key certificate information of the record.', - 'type' => 'string', - 'example' => 'dGVzdGFkYWxrcw==', - 'title' => '', - ], - 'Usage' => [ - 'description' => 'The usage identity of the record. The value range is **0~255**.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Selector' => [ - 'description' => 'The type of certificate or public key used by the record. The range is **0~255**.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'MatchingType' => [ - 'description' => 'The algorithm policy used by the record for matching or authenticating certificates. The range is **0~255**.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Fingerprint' => [ - 'description' => 'The public key fingerprint value of the record.', - 'type' => 'string', - 'example' => 'abcdef1234567890', - 'title' => '', - ], - 'Tag' => [ - 'description' => 'The tag of the record. For CAA records, the tag indicates its specific type and purpose.', - 'type' => 'string', - 'example' => 'issue', - 'title' => '', - ], + 'Value' => ['description' => 'The record value or partial content. The meaning varies by record type:'."\n" + ."\n" + .'- **A/AAAA**: the IP address that the record points to. Separate multiple IP addresses with commas (,). At least one IPv4 address is required.'."\n" + .'- **CNAME**: the target domain name that the record points to.'."\n" + .'- **NS**: the name server for the specified domain name.'."\n" + .'- **MX**: the valid target mail server domain name.'."\n" + .'- **TXT**: a valid text string.'."\n" + .'- **CAA**: a valid certification authority domain name.'."\n" + .'- **SRV**: a valid target host domain name.'."\n" + .'- **URI**: a valid URI string.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'Priority' => ['description' => 'The priority of the record. Valid values: **0 to 65535**. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Flag' => ['description' => 'The flag of the record. The Flag of a CAA record indicates its priority and processing method. Valid values: **0 to 255**.', 'type' => 'integer', 'format' => 'int32', 'example' => '128', 'title' => ''], + 'Tags' => ['description' => 'The tags of the record.', 'type' => 'object', 'example' => '{\\"test\\": \\"test val1\\"}', 'title' => ''], + 'Weight' => ['description' => 'The weight of the record. Valid values: **0 to 65535**.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Port' => ['description' => 'The port of the record. Valid values: **0 to 65535**.', 'type' => 'integer', 'format' => 'int32', 'example' => '8707', 'title' => ''], + 'Type' => ['description' => 'The certificate type of the record (in CERT records) or the public key type (in SSHFP records).', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'KeyTag' => ['description' => 'The public key identifier of the record. Valid values: **0 to 65535**.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Algorithm' => ['description' => 'The encryption algorithm used by the record. Valid values: **0 to 255**.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Certificate' => ['description' => 'The public key certificate information of the record.', 'type' => 'string', 'example' => 'dGVzdGFkYWxrcw==', 'title' => ''], + 'Usage' => ['description' => 'The usage identifier of the record. Valid values: **0 to 255**.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Selector' => ['description' => 'The type of certificate or public key used by the record. Valid values: **0 to 255**.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'MatchingType' => ['description' => 'The algorithm policy used by the record for matching or verifying certificates. Valid values: **0 to 255**.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Fingerprint' => ['description' => 'The public key fingerprint value of the record.', 'type' => 'string', 'example' => 'abcdef1234567890', 'title' => ''], + 'Tag' => ['description' => 'The tag of the record. The Tag of a CAA record indicates its specific type and purpose.', 'type' => 'string', 'example' => 'issue', 'title' => ''], ], 'example' => '{"value":"1.1.1.1"}', 'title' => '', ], - 'CreateTime' => [ - 'description' => 'The creation time of the record, formatted according to ISO8601 notation in UTC, with the format yyyy-MM-ddTHH:mm:ssZ.', - 'type' => 'string', - 'example' => '2023-03-10T13:30:39Z', - 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'The update time of the record, in ISO8601 notation and expressed in UTC, with the format yyyy-MM-ddTHH:mm:ssZ. ', - 'type' => 'string', - 'example' => '2023-01-27T02:26:22Z', - 'title' => '', - ], - 'Proxied' => [ - 'description' => 'Indicates whether proxy acceleration is enabled for the record. Only CNAME records and A/AAAA records support proxy acceleration. Valid values:'."\n" - ."\n" - .'- **true**: Proxy acceleration is enabled.'."\n" - .'- **false**: Proxy acceleration is disabled.', - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], - 'RecordId' => [ - 'description' => 'The record ID. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567890123', - 'title' => '', - ], - 'RecordName' => [ - 'description' => 'The record name.', - 'type' => 'string', - 'example' => 'a.example.com', - 'title' => '', - ], - 'RecordType' => [ - 'description' => 'The DNS record type, such as **A/AAAA, CNAME, TXT**, etc.', - 'type' => 'string', - 'example' => 'A/AAAA', - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'The site ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567890123', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The site name.', - 'type' => 'string', - 'example' => 'example.com', - 'title' => '', - ], - 'Ttl' => [ - 'description' => 'The time-to-live (TTL) of the record, in seconds. When the value is 1, it indicates that the TTL is set automatically.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], - 'RecordSourceType' => [ - 'description' => 'The origin type of the CNAME record. Valid values:'."\n" - ."\n" - .'- **OSS**: OSS origin.'."\n" - .'- **S3**: S3 origin.'."\n" - .'- **LB**: Server Load Balancer origin.'."\n" - .'- **OP**: Origin address pool.'."\n" - .'- **Domain**: Standard domain name origin.'."\n" - ."\n" - .'If this parameter is not specified or is empty, the default value is Domain, which indicates a standard domain name origin.', - 'type' => 'string', - 'example' => 'OSS ', - 'title' => '', - ], - 'RecordCname' => [ - 'description' => 'The canonical name (CNAME) of the record. ', - 'type' => 'string', - 'example' => 'a.example.com.cnamezone.com', - 'title' => '', - ], - 'Comment' => [ - 'description' => 'The comment for the record.', - 'type' => 'string', - 'example' => '这是一个备注信息', - 'title' => '', - ], + 'CreateTime' => ['description' => 'The creation time of the record. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2023-03-10T13:30:39Z', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time of the record. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2023-01-27T02:26:22Z', 'title' => ''], + 'Proxied' => ['description' => 'Indicates whether proxy acceleration is enabled for the record. Only CNAME and A/AAAA records support proxy acceleration. Valid values:'."\n" + ."\n" + .'- **true**: Proxy acceleration is enabled.'."\n" + .'- **false**: Proxy acceleration is disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RecordId' => ['description' => 'The record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''], + 'RecordName' => ['description' => 'The record name.', 'type' => 'string', 'example' => 'a.example.com', 'title' => ''], + 'RecordType' => ['description' => 'The DNS type of the record, such as **A/AAAA, CNAME, or TXT**.', 'type' => 'string', 'example' => 'A/AAAA', 'title' => ''], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'Ttl' => ['description' => 'The Time-to-Live (TTL) of the record, in seconds. A value of 1 indicates that the TTL is set to automatic.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'RecordSourceType' => ['description' => 'The origin type of the CNAME record. Valid values:'."\n" + ."\n" + .'- **OSS**: OSS origin.'."\n" + .'- **S3**: S3 origin.'."\n" + .'- **LB**: load balancing origin.'."\n" + .'- **OP**: IPAM pool origin.'."\n" + .'- **Domain**: standard domain name origin.'."\n" + ."\n" + .'If this parameter is not specified or is left empty, the default value is Domain, which indicates a standard domain name origin type.', 'type' => 'string', 'example' => 'OSS ', 'title' => ''], + 'RecordCname' => ['description' => 'The CNAME of the record.', 'type' => 'string', 'example' => 'a.example.com.cnamezone.com', 'title' => ''], + 'Comment' => ['description' => 'The comment of the record.', 'type' => 'string', 'example' => 'Remarks', 'title' => ''], 'AuthConf' => [ - 'description' => 'The origin authentication information for the CNAME record. ', + 'description' => 'The back-to-origin authentication information of the CNAME record.', 'type' => 'object', 'properties' => [ - 'AuthType' => [ - 'description' => 'The authentication type of the origin. Valid values: '."\n" - .'- **public**: public-read. Select this value when the origin type is OSS or S3 and the origin is publicly readable. '."\n" - .'- **private**: private. Select this value when the origin type is S3 and the origin is privately readable. '."\n" - .'- **private_same_account**: private read within the same account. Select this value when the origin type is OSS, the origin is privately readable, and both the origin and the current service belong to the same Alibaba Cloud account. '."\n" - .'- **private_cross_account**: private read across accounts. Select this value when the origin type is OSS, the origin is privately readable, and the origin belongs to a different Alibaba Cloud account. ', - 'type' => 'string', - 'example' => 'public', - 'title' => '', - ], - 'SecretKey' => [ - 'description' => 'The AccessKey of the account to which the origin belongs. ', - 'type' => 'string', - 'example' => 'u0Nkg5gBK*******QF5wvKMM504JUHt', - 'title' => '', - ], - 'AccessKey' => [ - 'description' => 'The AccessKey of the Alibaba Cloud account to which the origin belongs. ', - 'type' => 'string', - 'example' => 'VIxuvJSA2S03f******kp208dy5w7', - 'title' => '', - ], - 'Version' => [ - 'description' => 'The signature algorithm version. The following versions are supported: '."\n" - .'- **v2** '."\n" - .'- **v4** '."\n" - ."\n" - .'If not specified, the default is v4. ', - 'type' => 'string', - 'example' => 'v2', - 'title' => '', - ], - 'Region' => [ - 'description' => 'The area to which the origin belongs. You can obtain the region information from the official S3 website. ', - 'type' => 'string', - 'example' => 'us-east-1', - 'title' => '', - ], + 'AuthType' => ['description' => 'The origin authentication type. Valid values:'."\n" + .'- **public**: public read. Select this value when the origin type is OSS or S3 and the origin has public read access.'."\n" + .'- **private**: private read. Select this value when the origin type is S3 and the origin has private read access.'."\n" + .'- **private_same_account**: private read within the same account. Select this value when the origin type is OSS, the origin is under the same Alibaba Cloud account, and the origin has private read access.'."\n" + .'- **private_cross_account**: private read across accounts. Select this value when the origin type is OSS, the origin is under a different Alibaba Cloud account, and the origin has private read access.', 'type' => 'string', 'example' => 'public', 'title' => ''], + 'SecretKey' => ['description' => 'The AccessKey of the account to which the origin belongs.', 'type' => 'string', 'example' => 'u0Nkg5gBK*******QF5wvKMM504JUHt', 'title' => ''], + 'AccessKey' => ['description' => 'The AccessKey of the account to which the origin belongs.', 'type' => 'string', 'example' => 'VIxuvJSA2S03f******kp208dy5w7', 'title' => ''], + 'Version' => ['description' => 'The signature algorithm version. Valid values:'."\n" + .'- **v2**'."\n" + .'- **v4**'."\n" + ."\n" + .'Default value: v4.', 'type' => 'string', 'example' => 'v2', 'title' => ''], + 'Region' => ['description' => 'The region of the origin. Obtain the region from the official S3 website.', 'type' => 'string', 'example' => 'us-east-1', 'title' => ''], ], 'title' => '', 'example' => '', ], - 'HostPolicy' => [ - 'description' => 'The origin fetch HOST policy. This takes effect only when the record type is CNAME and defines the policy for including the HOST header during origin fetch. Two modes are available: '."\n" - ."\n" - .'- **follow_hostname**: Follow the host record. '."\n" - .'- **follow_origin_domain**: Follow the Origin Domain Name. ', - 'type' => 'string', - 'example' => 'follow_origin_domain', - 'title' => '', - ], + 'HostPolicy' => ['description' => 'The back-to-origin HOST policy. This parameter takes effect when the record type is CNAME. It specifies the HOST header policy for back-to-origin requests. Valid values:'."\n" + ."\n" + .'- **follow_hostname**: follows the host record.'."\n" + .'- **follow_origin_domain**: follows the origin domain name.', 'type' => 'string', 'example' => 'follow_origin_domain', 'title' => ''], ], 'title' => '', 'example' => '', @@ -47701,44 +27076,25 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], 404 => [ - [ - 'errorCode' => 'Record.NotFound', - 'errorMessage' => 'The record does not exist. Check your configurations and try again.', - 'description' => 'The record does not exist. Check your configurations and try again.', - ], + ['errorCode' => 'Record.NotFound', 'errorMessage' => 'The record does not exist. Check your configurations and try again.', 'description' => 'The record does not exist. Check your configurations and try again.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'title' => 'Query DNS record details ', - 'summary' => 'Obtain the detailed configuration information of a single DNS record, including the record value, priority, origin fetch authentication configuration (exclusive to CNAME records), and more.', + '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\\": \\"Remarks\\",\\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"}]', + 'title' => 'Query DNS record details', 'changeSet' => [ - [ - 'createdAt' => '2025-08-21T09:39:51.000Z', - 'description' => 'Response parameters changed', - ], - [ - 'createdAt' => '2024-09-23T08:53:22.000Z', - 'description' => 'Error codes changed, Response parameters changed', - ], + ['createdAt' => '2025-08-21T09:39:51.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-09-23T08:53:22.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetRecord', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRecord'], ], ], 'ramActions' => [ @@ -47749,26 +27105,16 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', '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' => [ 'summary' => 'Query Redirect Rule Details', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -47780,34 +27126,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257659', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '34003500310****', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '34003500310****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID. It can be obtained by calling the [ListRedirectRules](~~ListRedirectRules~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'Configuration ID. It can be obtained by calling the [ListRedirectRules](~~ListRedirectRules~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '35281609698****', 'title' => ''], ], ], 'responses' => [ @@ -47817,96 +27147,33 @@ 'description' => 'Request response result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - ], - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '35281609698****', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'Configuration type. Possible values:'."\n" - .'- global: Global configuration.'."\n" - .'- rule: Rule-based configuration.', - 'type' => 'string', - 'example' => 'rule', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'The version number of the site configuration. For sites with version management enabled, this parameter can specify the effective version of the site, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'Rule execution order. The smaller the value, the higher the priority.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Possible values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, e.g., (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], - 'Type' => [ - 'description' => 'Redirect type. Possible values:'."\n" - .'- static: Static mode.'."\n" - .'- dynamic: Dynamic mode.', - 'type' => 'string', - 'example' => 'static', - 'title' => '', - ], - 'TargetUrl' => [ - 'description' => 'Target URL after redirection.', - 'type' => 'string', - 'example' => 'http://www.exapmle.com/index.html', - 'title' => '', - ], - 'StatusCode' => [ - 'description' => 'Response status code used by the node to respond to the client with the redirect address. Possible values:'."\n" - .'- 301'."\n" - .'- 302'."\n" - .'- 303'."\n" - .'- 307'."\n" - .'- 308', - 'type' => 'string', - 'example' => '301', - 'title' => '', - ], - 'ReserveQueryString' => [ - 'description' => 'Preserve query string. Possible values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9'], + 'ConfigId' => ['description' => 'Configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '35281609698****', 'title' => ''], + 'ConfigType' => ['description' => 'Configuration type. Possible values:'."\n" + .'- global: Global configuration.'."\n" + .'- rule: Rule-based configuration.', 'type' => 'string', 'example' => 'rule', 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the site configuration. For sites with version management enabled, this parameter can specify the effective version of the site, defaulting to version 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Sequence' => ['description' => 'Rule execution order. The smaller the value, the higher the priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuleEnable' => ['description' => 'Rule switch. This parameter is not required when adding a global configuration. Possible values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" + .'- Match all incoming requests: Set the value to true'."\n" + .'- Match specific requests: Set the value to a custom expression, e.g., (http.host eq \\"video.example.com\\")', 'type' => 'string', 'example' => '(http.host eq "video.example.com")', 'title' => ''], + 'RuleName' => ['description' => 'Rule name. This parameter is not required when adding a global configuration.', 'type' => 'string', 'example' => 'rule_example', 'title' => ''], + 'Type' => ['description' => 'Redirect type. Possible values:'."\n" + .'- static: Static mode.'."\n" + .'- dynamic: Dynamic mode.', 'type' => 'string', 'example' => 'static', 'title' => ''], + 'TargetUrl' => ['description' => 'Target URL after redirection.', 'type' => 'string', 'example' => 'http://www.exapmle.com/index.html', 'title' => ''], + 'StatusCode' => ['description' => 'Response status code used by the node to respond to the client with the redirect address. Possible values:'."\n" + .'- 301'."\n" + .'- 302'."\n" + .'- 303'."\n" + .'- 307'."\n" + .'- 308', 'type' => 'string', 'example' => '301', 'title' => ''], + 'ReserveQueryString' => ['description' => 'Preserve query string. Possible values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], ], 'example' => '', ], @@ -47914,27 +27181,16 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'Query Redirect Configuration Details', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetRedirectRule', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRedirectRule'], ], ], 'ramActions' => [ @@ -47945,12 +27201,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -47959,12 +27210,8 @@ ], 'GetRewriteUrlRule' => [ 'summary' => 'Query details of the rewrite URL rule', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -47976,34 +27223,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257643', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****'."\n", 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID, which can be obtained by calling the [ListRewriteUrlRules](~~2867480~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'Configuration ID, which can be obtained by calling the [ListRewriteUrlRules](~~2867480~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '35281609698****', 'title' => ''], ], ], 'responses' => [ @@ -48013,93 +27244,30 @@ 'description' => 'Request response result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - ], - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '35281609698****', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'Configuration type. Possible values:'."\n" - .'- global: Global configuration;'."\n" - .'- rule: Rule-based configuration;', - 'type' => 'string', - 'example' => 'global', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the effective version of the site, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'Rule execution order. The smaller the value, the higher the priority for execution.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Rule switch. This parameter does not need to be set when adding a global configuration. Possible values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter does not need to be set when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, e.g., (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'Rule name. This parameter does not need to be set when adding a global configuration.', - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], - 'RewriteUriType' => [ - 'description' => 'URI rewrite type. Possible values:'."\n" - ."\n" - .'- static: Static mode.'."\n" - .'- dynamic: Dynamic mode.', - 'type' => 'string', - 'example' => 'static', - 'title' => '', - ], - 'Uri' => [ - 'description' => 'The target URI after rewriting.', - 'type' => 'string', - 'example' => '/image/example.jpg', - 'title' => '', - ], - 'RewriteQueryStringType' => [ - 'description' => 'Query string rewrite type. Possible values:'."\n" - ."\n" - .'- static: Static mode.'."\n" - .'- dynamic: Dynamic mode.', - 'type' => 'string', - 'example' => 'static', - 'title' => '', - ], - 'QueryString' => [ - 'description' => 'The rewritten query string.', - 'type' => 'string', - 'example' => 'example=123', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9'], + 'ConfigId' => ['description' => 'Configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '35281609698****', 'title' => ''], + 'ConfigType' => ['description' => 'Configuration type. Possible values:'."\n" + .'- global: Global configuration;'."\n" + .'- rule: Rule-based configuration;', 'type' => 'string', 'example' => 'global', 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the effective version of the site, defaulting to version 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Sequence' => ['description' => 'Rule execution order. The smaller the value, the higher the priority for execution.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuleEnable' => ['description' => 'Rule switch. This parameter does not need to be set when adding a global configuration. Possible values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'Rule content, using conditional expressions to match user requests. This parameter does not need to be set when adding a global configuration. There are two usage scenarios:'."\n" + .'- Match all incoming requests: Set the value to true'."\n" + .'- Match specific requests: Set the value to a custom expression, e.g., (http.host eq \\"video.example.com\\")', 'type' => 'string', 'example' => '(http.host eq "video.example.com")', 'title' => ''], + 'RuleName' => ['description' => 'Rule name. This parameter does not need to be set when adding a global configuration.', 'type' => 'string', 'example' => 'rule_example', 'title' => ''], + 'RewriteUriType' => ['description' => 'URI rewrite type. Possible values:'."\n" + ."\n" + .'- static: Static mode.'."\n" + .'- dynamic: Dynamic mode.', 'type' => 'string', 'example' => 'static', 'title' => ''], + 'Uri' => ['description' => 'The target URI after rewriting.', 'type' => 'string', 'example' => '/image/example.jpg', 'title' => ''], + 'RewriteQueryStringType' => ['description' => 'Query string rewrite type. Possible values:'."\n" + ."\n" + .'- static: Static mode.'."\n" + .'- dynamic: Dynamic mode.', 'type' => 'string', 'example' => 'static', 'title' => ''], + 'QueryString' => ['description' => 'The rewritten query string.', 'type' => 'string', 'example' => 'example=123', 'title' => ''], ], 'example' => '', ], @@ -48107,27 +27275,16 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'Query Rewrite URL Configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetRewriteUrlRule', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRewriteUrlRule'], ], ], 'ramActions' => [ @@ -48138,12 +27295,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -48151,15 +27303,9 @@ 'operationType' => 'read', ], 'GetRoutine' => [ - 'summary' => 'Query all configuration information of the Edge Routine, including the code version list, environment configuration list, associated domain configuration list, and associated Ingress configuration list.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Queries all configuration information of an Edge Routine, including the code version list, environment configuration list, associated domain name configuration list, and associated route configuration list.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -48172,106 +27318,55 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239274', - 'abilityTreeNodes' => [ - 'FEATUREdcdn75UYDO', - ], + 'abilityTreeNodes' => ['FEATUREdcdn75UYDO'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The routine name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-routine1', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Edge Routine.', 'type' => 'string', 'required' => true, 'example' => 'test-routine1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395'], 'Envs' => [ - 'description' => 'The information about the environments.'."\n", + 'description' => 'The list of environment context.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the environment.'."\n", + 'description' => 'The environment context.', 'type' => 'object', 'properties' => [ - 'Env' => [ - 'description' => 'The environment type.'."\n", - 'type' => 'string', - 'example' => 'production', - 'title' => '', - ], + 'Env' => ['description' => 'The environment name.', 'type' => 'string', 'example' => 'production', 'title' => ''], 'CodeDeploy' => [ - 'description' => 'Canary release version deployment information.', + 'description' => 'The percentage-based canary release deployment information.', 'type' => 'object', 'properties' => [ - 'DeployId' => [ - 'description' => 'Deployment record ID.', - 'type' => 'string', - 'example' => '589267', - 'title' => '', - ], - 'CreationTime' => [ - 'description' => 'Deployment creation time.', - 'type' => 'string', - 'example' => '2023-05-11T09:21:36Z', - 'title' => '', - ], + 'DeployId' => ['description' => 'The deployment record ID.', 'type' => 'string', 'example' => '589267', 'title' => ''], + 'CreationTime' => ['description' => 'The time when the deployment was created. The time follows the RFC 3339 standard in the UTC time zone.', 'type' => 'string', 'example' => '2023-05-11T09:21:36Z', 'title' => ''], 'Strategy' => [ - 'enumValueTitles' => [ - 'percentage' => 'percentage ', - ], - 'description' => 'Deployment policy. Default is percentage. ', + 'description' => 'The deployment strategy. Default value: percentage.', + 'enumValueTitles' => ['percentage' => 'percentage'], 'type' => 'string', 'example' => 'percentage', 'title' => '', ], 'CodeVersions' => [ - 'description' => 'List of deployed code version numbers.', + 'description' => 'The list of deployed code version numbers.', 'type' => 'array', 'items' => [ - 'description' => 'Information of a single deployed code version.', + 'description' => 'The information about a single deployed code version.', 'type' => 'object', 'properties' => [ - 'CodeVersion' => [ - 'description' => 'Version number of the code. ', - 'type' => 'string', - 'example' => '1746583193971399525', - 'title' => '', - ], - 'Percentage' => [ - 'description' => 'Grayscale deployment percentage of the code version. ', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - 'title' => '', - ], - 'Description' => [ - 'description' => 'Description of the code version. ', - 'type' => 'string', - 'example' => 'code version 1.', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'Creation Time of the code version. ', - 'type' => 'string', - 'example' => '2025-07-23T09:01:40Z', - 'title' => '', - ], + 'CodeVersion' => ['description' => 'The code version number.', 'type' => 'string', 'example' => '1746583193971399525', 'title' => ''], + 'Percentage' => ['description' => 'The canary release percentage of the code version.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'Description' => ['description' => 'The description of the code version.', 'type' => 'string', 'example' => 'code version 1.', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the code version was created. The time follows the RFC 3339 standard in the UTC time zone.', 'type' => 'string', 'example' => '2025-07-23T09:01:40Z', 'title' => ''], ], 'title' => '', 'example' => '', @@ -48290,30 +27385,10 @@ 'title' => '', 'example' => '', ], - 'CreateTime' => [ - 'description' => 'The time when the routine was created.'."\n", - 'type' => 'string', - 'example' => '2024-03-11T01:23:21Z'."\n", - 'title' => '', - ], - 'Description' => [ - 'description' => 'The description of the routine.'."\n", - 'type' => 'string', - 'example' => 'ZWRpdCByb3V0aW5lIGNvbmZpZyBkZXNjcmlwdGlvbg', - 'title' => '', - ], - 'DefaultRelatedRecord' => [ - 'description' => 'The default record name to access.'."\n", - 'type' => 'string', - 'example' => 'routine1.example.com', - 'title' => '', - ], - 'HasAssets' => [ - 'description' => 'Indicates whether the Routine has the Assets mark. ', - 'type' => 'boolean', - 'example' => 'false', - 'title' => '', - ], + 'CreateTime' => ['description' => 'The time when the Edge Routine was created. The time follows the RFC 3339 standard in the UTC time zone.', 'type' => 'string', 'example' => '2024-03-11T01:23:21Z'."\n", 'title' => ''], + 'Description' => ['description' => 'The description of the Edge Routine.', 'type' => 'string', 'example' => 'ZWRpdCByb3V0aW5lIGNvbmZpZyBkZXNjcmlwdGlvbg', 'title' => ''], + 'DefaultRelatedRecord' => ['description' => 'The default access record.', 'type' => 'string', 'example' => 'routine1.example.com', 'title' => ''], + 'HasAssets' => ['description' => 'Indicates whether the Routine has the Assets tag.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'example' => '', ], @@ -48321,43 +27396,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter verification failed. Check your configurations and try again.', - 'description' => 'Parameter verification failed. Check your configurations and try again.', - ], - [ - 'errorCode' => 'RoutineNotExist', - 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', - 'description' => 'The routine name does not exist. Check the routine name and try again.', - ], - [ - 'errorCode' => 'InternalOperationError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter verification failed. Check your configurations and try again.', 'description' => 'Parameter verification failed. Check your configurations and try again.'], + ['errorCode' => 'RoutineNotExist', 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', 'description' => 'The routine name does not exist. Check the routine name and try again.'], + ['errorCode' => 'InternalOperationError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'title' => 'Query Edge Routine configuration ', + '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"}]', + 'title' => 'Query edge routine configuration', 'changeSet' => [ - [ - 'createdAt' => '2024-12-04T05:48:49.000Z', - 'description' => 'Request parameters changed, Response parameters changed', - ], + ['createdAt' => '2024-12-04T05:48:49.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetRoutine', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRoutine'], ], ], 'ramActions' => [ @@ -48368,97 +27420,146 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', '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' => [ - 'summary' => 'Queries information about a code version of a routine.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Queries the code information of a specific version of an Edge Routine.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239164', - 'abilityTreeNodes' => [ - 'FEATUREdcdn75UYDO', - ], + 'abilityTreeNodes' => ['FEATUREdcdn75UYDO'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The routine name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-routine1', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Edge Routine.', 'type' => 'string', 'required' => true, 'example' => 'test-routine1', 'title' => ''], ], [ 'name' => 'CodeVersion', 'in' => 'formData', + 'schema' => ['description' => 'The code version number.', 'type' => 'string', 'required' => true, 'example' => '1710120201067203242', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The code version.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1710120201067203242', 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395'], + 'CodeDescription' => ['description' => 'The description of the code version.', 'type' => 'string', 'example' => 'test ver code desc'."\n", 'title' => ''], + 'CreateTime' => ['description' => 'The creation time. The time follows the RFC 3339 standard in the UTC time zone.', 'type' => 'string', 'example' => '2024-03-11T01:23:21Z'."\n", 'title' => ''], + 'RoutineCode' => ['description' => 'The code content.', 'type' => 'string', 'example' => 'PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPEVycm9yPgogIDxDb2RlPk5vU3VjaEtleTwvQ29kZT4KICA8TWVzc2FnZT5UaGUgc3BlY2lmaWVkIGtleSBkb2VzIG5vdCBleGlzdC48L01lc3NhZ2U', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'RoutineNotExist', 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', 'description' => 'The routine name does not exist. Check the routine name and try again.'], + ['errorCode' => 'InternalOperationError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => '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.'], + ['errorCode' => 'RoutineUserServiceStatusHalt', 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', 'description' => 'Failed to update the configurations because you have overdue payments.'], + ['errorCode' => 'ParameterNotExist', 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', 'description' => 'The specified parameter does not exist. Check your configurations and try again.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + '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"}]', + 'title' => 'Query code information of a specific edge routine version', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRoutineCodeVersion'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:GetRoutineCodeVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + ], + 'GetRoutineCodeVersionInfo' => [ + 'summary' => 'Queries the status and other information of a specific code version of a specified Routine.', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['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' => 'The name of the Edge Routine.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'CodeVersion', + 'in' => 'formData', + 'schema' => ['description' => 'The code version number to query.', 'type' => 'string', 'required' => true, 'example' => '1710120201067203242', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', - ], - 'CodeDescription' => [ - 'description' => 'The description of the code version.'."\n", - 'type' => 'string', - 'example' => 'test ver code desc'."\n", - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the version was created.'."\n", - 'type' => 'string', - 'example' => '2024-03-11T01:23:21Z'."\n", - 'title' => '', - ], - 'RoutineCode' => [ - 'description' => 'The code content.'."\n", - 'type' => 'string', - 'example' => 'PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPEVycm9yPgogIDxDb2RlPk5vU3VjaEtleTwvQ29kZT4KICA8TWVzc2FnZT5UaGUgc3BlY2lmaWVkIGtleSBkb2VzIG5vdCBleGlzdC48L01lc3NhZ2U', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9'], + 'CodeVersion' => ['description' => 'The code version number.', 'type' => 'string', 'example' => '1710120201067203242', 'title' => ''], + 'Status' => ['description' => 'The status of the code version.', 'type' => 'string', 'example' => 'Available', 'title' => ''], + 'CodeDescription' => ['description' => 'The description of the code version.', 'type' => 'string', 'example' => 'code desc version unstable', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the code version was created. The time follows the RFC 3339 standard in the UTC time zone.', 'type' => 'string', 'example' => '2025-08-04T01:54:19Z', 'title' => ''], + 'HasAssets' => ['description' => 'Indicates whether the code version contains Assets files.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ExtraInfo' => ['description' => 'The extra information of the code version. The value is in JSON string format.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'BuildId' => ['description' => 'The build ID of the code.', 'type' => 'integer', 'format' => 'int64', 'example' => '26035169', 'title' => ''], + 'ConfOptions' => [ + 'description' => 'The list of configuration items for the code version.', + 'type' => 'object', + 'properties' => [ + 'NotFoundStrategy' => ['description' => 'The NotFoundStrategy configuration item.', 'type' => 'string', 'example' => 'SinglePageApplication', 'title' => ''], + ], 'title' => '', + 'example' => '', ], ], 'example' => '', @@ -48467,48 +27568,19 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'RoutineNotExist', - 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', - 'description' => 'The routine name does not exist. Check the routine name and try again.', - ], - [ - 'errorCode' => 'InternalOperationError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'RoutineUserServiceStatusHalt', - 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', - 'description' => 'Failed to update the configurations because you have overdue payments.', - ], - [ - 'errorCode' => 'ParameterNotExist', - 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', - 'description' => 'The specified parameter does not exist. Check your configurations and try again.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'RoutineNotExist', 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', 'description' => 'The routine name does not exist. Check the routine name and try again.'], + ['errorCode' => 'InternalOperationError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => '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.'], + ['errorCode' => 'RoutineUserServiceStatusHalt', 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', 'description' => 'Failed to update the configurations because you have overdue payments.'], + ['errorCode' => 'ParameterNotExist', 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', 'description' => 'The specified parameter does not exist. Check your configurations and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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"}]', - 'title' => 'GetRoutineCodeVersion', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query routine code version information', + 'description' => '## Operation description'."\n" + .'By calling this API operation, you can retrieve detailed information about a specific code version of a Routine, including but not limited to the version status, creation time, and whether the version contains Assets resource files. You must specify the Routine name and the code version number as request parameters.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -48517,31 +27589,21 @@ [ 'operationType' => 'none', 'ramAction' => [ - 'action' => 'esa:GetRoutineCodeVersion', + 'action' => 'esa:GetRoutineCodeVersionInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'operationType' => 'read', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"CodeVersion\\": \\"1710120201067203242\\",\\n \\"Status\\": \\"Available\\",\\n \\"CodeDescription\\": \\"code desc version unstable\\",\\n \\"CreateTime\\": \\"2025-08-04T01:54:19Z\\",\\n \\"HasAssets\\": true,\\n \\"ExtraInfo\\": \\"{}\\",\\n \\"BuildId\\": 26035169,\\n \\"ConfOptions\\": {\\n \\"NotFoundStrategy\\": \\"SinglePageApplication\\"\\n }\\n}","type":"json"}]', ], 'GetRoutineRoute' => [ - 'summary' => 'Queries the route configurations of a single edge function.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the configuration of a single Edge Routine route.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -48554,133 +27616,51 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '266193', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the configuration. You can call the [ListSiteRoutes](~~2879631~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID. You can call the [ListSiteRoutes](~~2879631~~) operation to obtain the ConfigId.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '35281609698****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], - 'ConfigId' => [ - 'description' => 'The configuration ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '352816******', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'The configuration type to query. Valid values:'."\n" - ."\n" - .'* global: global configurations.'."\n" - .'* rule: queries rule configurations.'."\n", - 'type' => 'string', - 'example' => 'global', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'The version number of the website.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'The order in which the rule is executed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RouteEnable' => [ - 'description' => 'The routing switch. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'The rule content.'."\n", - 'type' => 'string', - 'example' => '(http.host eq \\"video.example.com\\")'."\n", - 'title' => '', - ], - 'RouteName' => [ - 'description' => 'The route name.'."\n", - 'type' => 'string', - 'example' => 'test_route', - 'title' => '', - ], - 'RoutineName' => [ - 'description' => 'The function name.'."\n", - 'type' => 'string', - 'example' => 'test-routine1', - 'title' => '', - ], - 'Bypass' => [ - 'description' => 'Bypass mode. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Mode' => [ - 'description' => 'The configuration mode. Valid values: Valid values:'."\n" - ."\n" - .'* simple'."\n" - .'* custom'."\n", - 'type' => 'string', - 'example' => 'simple', - 'title' => '', - ], - 'Fallback' => [ - 'description' => 'The exception origin fetch switch. After you turn on this switch, if a function exception occurs, such as CPU usage exceeding the upper limit, requests are sent back to the origin. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '352816******', 'title' => ''], + 'ConfigType' => ['description' => 'The configuration type. You can use this parameter to query global or rule configurations. Valid values:'."\n" + ."\n" + .'- global: queries global configurations.'."\n" + .'- rule: queries rule configurations.', 'type' => 'string', 'example' => 'global', 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the site.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Sequence' => ['description' => 'The rule execution order.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RouteEnable' => ['description' => 'The route switch. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'The rule content.', 'type' => 'string', 'example' => '(http.host eq \\"video.example.com\\")'."\n", 'title' => ''], + 'RouteName' => ['description' => 'The route name.', 'type' => 'string', 'example' => 'test_route', 'title' => ''], + 'RoutineName' => ['description' => 'The Edge Routine name.', 'type' => 'string', 'example' => 'test-routine1', 'title' => ''], + 'Bypass' => ['description' => 'The bypass mode. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Mode' => ['description' => 'The configuration mode. Valid values:'."\n" + .'- simple: simple mode.'."\n" + .'- custom: custom mode.', 'type' => 'string', 'example' => 'simple', 'title' => ''], + 'Fallback' => ['description' => 'The back-to-origin on exception switch. When enabled, if the function encounters an exception such as CPU usage exceeding the limit, the request is forwarded to the origin. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Timeout' => ['title' => '', 'description' => 'The Edge Routine timeout period. Valid values: 5 to 60. Unit: seconds.', 'type' => 'string', 'example' => '5'], ], 'example' => '', ], @@ -48688,29 +27668,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - '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"}]', - 'title' => 'GetRoutineRoute', + '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 \\"Timeout\\": \\"5\\"\\n}","type":"json"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'Query a single edge routine route configuration', 'changeSet' => [ - [ - 'createdAt' => '2025-06-25T05:35:34.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-06-25T05:35:34.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '20', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetRoutineRoute', - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRoutineRoute'], ], ], 'ramActions' => [ @@ -48721,26 +27692,15 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], ], 'GetRoutineStagingCodeUploadInfo' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -48752,32 +27712,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238993', - 'abilityTreeNodes' => [ - 'FEATUREdcdn75UYDO', - ], + 'abilityTreeNodes' => ['FEATUREdcdn75UYDO'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The routine name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-routine1', - 'title' => '', - ], + 'schema' => ['description' => 'The routine name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-routine1', 'title' => ''], ], [ 'name' => 'CodeDescription', 'in' => 'formData', - 'schema' => [ - 'description' => 'The code description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'the description of code', - 'title' => '', - ], + 'schema' => ['description' => 'The code description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'the description of code', 'title' => ''], ], ], 'responses' => [ @@ -48787,32 +27733,17 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', - ], - 'CodeVersion' => [ - 'description' => 'The code version.'."\n", - 'type' => 'string', - 'example' => '1710120201067203242', - 'title' => '', - ], - 'OssPostConfig' => [ - 'description' => 'The configuration information that can be used to upload to OSS.'."\n", - '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" - .'}', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395'], + 'CodeVersion' => ['description' => 'The code version.'."\n", 'type' => 'string', 'example' => '1710120201067203242', 'title' => ''], + 'OssPostConfig' => ['description' => 'The configuration information that can be used to upload to OSS.'."\n", '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" + .'}', 'title' => ''], ], 'example' => '', ], @@ -48820,50 +27751,21 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'RoutineNotExist', - 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', - 'description' => 'The routine name does not exist. Check the routine name and try again.', - ], - [ - 'errorCode' => 'InternalOperationError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'RoutineUserServiceStatusHalt', - 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', - 'description' => 'Failed to update the configurations because you have overdue payments.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'RoutineNotExist', 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', 'description' => 'The routine name does not exist. Check the routine name and try again.'], + ['errorCode' => 'InternalOperationError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => '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.'], + ['errorCode' => 'RoutineUserServiceStatusHalt', 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', 'description' => 'Failed to update the configurations because you have overdue payments.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetRoutineStagingCodeUploadInfo', 'summary' => 'Obtains the release information about the routine code that is released to the staging environment. This information can be used to upload the test code to Object Storage Service (OSS).', 'description' => '* Every time the code of a routine is released to the staging environment, a version number is generated. Such code is for tests only.'."\n" .'* A routine can retain a maximum of 10 code versions. If the number of versions reaches the limit, you must call the DeleteRoutineCodeRevision operation to delete unwanted versions.'."\n", 'changeSet' => [ - [ - 'createdAt' => '2024-12-04T05:48:48.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2024-12-04T05:48:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], @@ -48876,12 +27778,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -48890,13 +27787,9 @@ 'operationType' => 'read', ], 'GetScheduledPreloadJob' => [ - 'summary' => 'Queries a specified scheduled prefetch task based on the task ID.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries a single scheduled prefetch task by task ID.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -48909,133 +27802,51 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238950', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4TTNAL', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4TTNAL'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the scheduled prefetch task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '665d3af3621bccf3fe29e1a4', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the scheduled prefetch task.', 'type' => 'string', 'required' => true, 'example' => '665d3af3621bccf3fe29e1a4', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - ], - 'AliUid' => [ - 'title' => '', - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => '15685865xxx14622', - ], - 'CreatedAt' => [ - 'title' => '', - 'description' => 'The time when the task was created.'."\n", - 'type' => 'string', - 'example' => '2024-06-02T02:23:26Z', - ], - 'Domains' => [ - 'title' => '', - 'description' => 'The domain names to be prefetched.'."\n", - 'type' => 'string', - 'example' => 'testurl.com', - ], - 'ErrorInfo' => [ - 'title' => '', - 'description' => 'The error message that is returned.'."\n", - 'type' => 'string', - 'example' => 'invalid domain:test.com', - ], - 'FailedFileOss' => [ - 'title' => '', - 'description' => 'The URL of the OSS object that stores a list of URLs that failed the conditional check for prefetching.'."\n", - 'type' => 'string', - 'example' => 'https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7', - ], - 'FileId' => [ - 'title' => '', - 'description' => 'The ID of the URL list file, which can be used during downloads.'."\n", - 'type' => 'string', - 'example' => '665d3b48621bccf3fe29e1a7', - ], - 'Id' => [ - 'title' => '', - 'description' => 'The ID of the prefetch task.'."\n", - 'type' => 'string', - 'example' => '665d3af3621bccf3fe29e1a4', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74'], + 'AliUid' => ['title' => '', 'description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '15685865xxx14622'], + 'CreatedAt' => ['title' => '', 'description' => 'The time when the task was created, in ISO 8601 format (for example, 2024-01-01T00:00:00+Z).', 'type' => 'string', 'example' => '2024-06-02T02:23:26Z'], + 'Domains' => ['title' => '', 'description' => 'The list of domain names for prefetch.', 'type' => 'string', 'example' => 'testurl.com'], + 'ErrorInfo' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'invalid domain:test.com'], + 'FailedFileOss' => ['title' => '', 'description' => 'The OSS address of the failed file.', 'type' => 'string', 'example' => 'https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7'], + 'FileId' => ['title' => '', 'description' => 'The ID of the URL list file, used for downloading.', 'type' => 'string', 'example' => '665d3b48621bccf3fe29e1a7'], + 'Id' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => '665d3af3621bccf3fe29e1a4'], 'InsertWay' => [ 'title' => '', - 'description' => 'The method to submit the URLs to be prefetched.'."\n", + 'description' => 'The URL insertion method.', + 'enumValueTitles' => ['oss' => 'Batch import URLs from an OSS file.', 'testBox' => 'Enter URLs one by one in a text box.'], 'type' => 'string', + 'enum' => ['file', 'url'], 'example' => 'oss', - 'enum' => [ - 'file', - 'url', - ], - ], - 'Name' => [ - 'title' => '', - 'description' => 'The task name.'."\n", - 'type' => 'string', - 'example' => 'example', - ], - 'SiteId' => [ - 'title' => '', - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '190007158391808', - ], - 'TaskSubmitted' => [ - 'title' => '', - 'description' => 'The number of submitted prefetch tasks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', ], + 'Name' => ['title' => '', 'description' => 'The task name.', 'type' => 'string', 'example' => 'example'], + 'SiteId' => ['title' => '', 'description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '190007158391808'], + 'TaskSubmitted' => ['title' => '', 'description' => 'The number of URLs that have been submitted to the system for prefetch.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'TaskType' => [ 'title' => '', - 'description' => 'The task type. Valid values: refresh and preload.'."\n", + 'description' => 'The task type (refresh or prefetch).', + 'enumValueTitles' => ['path' => 'Directory refresh.', 'refresh' => 'URL refresh.', 'preload' => 'URL prefetch.'], 'type' => 'string', + 'enum' => ['preload', 'refresh', 'path'], 'example' => 'preload', - 'enum' => [ - 'preload', - 'refresh', - 'path', - ], - ], - 'UrlCount' => [ - 'title' => '', - 'description' => 'The total number of URLs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'UrlSubmitted' => [ - 'title' => '', - 'description' => 'The number of submitted URLs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', ], + 'UrlCount' => ['title' => '', 'description' => 'The total number of URLs.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'UrlSubmitted' => ['title' => '', 'description' => 'The number of submitted URLs.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], 'example' => '', ], @@ -49043,109 +27854,41 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], - [ - 'errorCode' => 'InvalidJob.JobCountOfSiteFull', - 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', - 'description' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', - ], - [ - 'errorCode' => 'InvalidParameter.ObjectId', - 'errorMessage' => 'Invalid task ID or execution plan ID.', - 'description' => 'Invalid task ID or execution plan ID.', - ], - [ - 'errorCode' => 'MissingOssUrl', - 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', - 'description' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', - ], - [ - 'errorCode' => 'MissingUrlList', - 'errorMessage' => 'Enter the URLs you want to prefetch.', - 'description' => 'Enter the URLs you want to prefetch.', - ], - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests.Please try again later.', - 'description' => 'Requests are too frequent, please try again later.', - ], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'InvalidJob.JobCountOfSiteFull', 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', 'description' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.'], + ['errorCode' => 'InvalidParameter.ObjectId', 'errorMessage' => 'Invalid task ID or execution plan ID.', 'description' => 'Invalid task ID or execution plan ID.'], + ['errorCode' => 'MissingOssUrl', 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', 'description' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.'], + ['errorCode' => 'MissingUrlList', 'errorMessage' => 'Enter the URLs you want to prefetch.', 'description' => 'Enter the URLs you want to prefetch.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], ], 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' => '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.', - ], + ['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' => '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.'], ], [ - [ - 'errorCode' => 'InvalidJob.NotFound', - 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', - 'description' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', - ], - [ - 'errorCode' => 'LogNotFound', - 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', - 'description' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', - ], - [ - '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' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.', - ], + ['errorCode' => 'InvalidJob.NotFound', 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', 'description' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.'], + ['errorCode' => 'LogNotFound', 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', 'description' => 'Failed to query the log. Check whether the task ID and execution ID are valid.'], + ['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' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], '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"}]', - 'title' => 'GetScheduledPreloadJob', + 'title' => 'Query a single scheduled prefetch task', '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetScheduledPreloadJob'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], + 'ramActions' => [], ], 'GetSeoBypass' => [ 'summary' => 'Queries the configuration for search engine crawler of a website.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -49157,22 +27900,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257451', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], ], 'responses' => [ @@ -49182,22 +27916,14 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247B78', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247B78'], 'Enable' => [ 'description' => 'The status of the feature. Valid values:'."\n" ."\n" .'* **on**'."\n" .'* **off**'."\n", 'type' => 'string', - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], + 'enumValueTitles' => ['off' => 'off', 'on' => 'on'], 'example' => 'on', 'title' => '', ], @@ -49208,27 +27934,16 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247B78\\",\\n \\"Enable\\": \\"on\\"\\n}","type":"json"}]', 'title' => 'GetSeoBypass', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetSeoBypass', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSeoBypass'], ], ], 'ramActions' => [ @@ -49239,12 +27954,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -49252,12 +27962,8 @@ 'operationType' => 'read', ], 'GetSite' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -49270,22 +27976,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239631', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the site. Call the [ListSites](~~2850189~~) operation to obtain this ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], ], 'responses' => [ @@ -49293,155 +27990,69 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9732E117-8A37-49FD-A36F-ABBB87556CA7', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9732E117-8A37-49FD-A36F-ABBB87556CA7'], 'SiteModel' => [ - 'description' => 'The queried website information.'."\n", + 'description' => 'The details of the site.', 'type' => 'object', 'properties' => [ - 'AccessType' => [ - 'description' => 'The DNS setup option for the website. Valid values:'."\n" - ."\n" - .'* **NS**'."\n" - .'* **CNAME**'."\n", - 'type' => 'string', - 'example' => 'NS', - 'title' => '', - ], - 'CnameZone' => [ - 'description' => 'The CNAME of the website domain. If you use CNAME setup when you add your website to ESA, the value is the CNAME that you configured then.'."\n", - 'type' => 'string', - 'example' => 'example.cname.com', - 'title' => '', - ], - 'Coverage' => [ - 'description' => 'The service location. Valid values:'."\n" - ."\n" - .'* **domestic**: the Chinese mainland.'."\n" - .'* **global**: global.'."\n" - .'* **overseas**: outside the Chinese mainland.'."\n", - 'type' => 'string', - 'example' => 'domestic', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the WEBsite was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-12-24T02:01:11Z', - 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'The time when the WEBsite was updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-12-24T02:01:11Z', - 'title' => '', - ], - 'InstanceId' => [ - 'description' => 'The plan ID.'."\n", - 'type' => 'string', - 'example' => 'cas-merge-q6h0bv', - 'title' => '', - ], - 'NameServerList' => [ - 'description' => 'The nameservers assigned to the website domain. They are separated by commas (,).'."\n", - 'type' => 'string', - 'example' => 'male1-1.ialicdn.com,female1-1.ialicdn.com', - 'title' => '', - ], - 'PlanName' => [ - 'description' => 'The plan name.'."\n", - 'type' => 'string', - 'example' => 'plan-168777532****', - 'title' => '', - ], - 'PlanSpecName' => [ - 'description' => 'The specification of the plan associated with the website.'."\n", - 'type' => 'string', - 'example' => 'normal', - 'title' => '', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of your Alibaba Cloud resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-aek26g6i6se****', - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567890123', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The website status. Valid values:'."\n" - ."\n" - .'* **pending**: The website is to be configured.'."\n" - .'* **active**: The website is active.'."\n" - .'* **offline**: The website is suspended.'."\n" - .'* **moved**: The website has been added and verified by another Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => 'pending', - 'title' => '', - ], - 'Tags' => [ - 'description' => 'The tags of the website.'."\n", - 'type' => 'object', - 'example' => '{"tag1":"value1"}', - 'title' => '', - ], - 'VerifyCode' => [ - 'description' => 'The code that is used to verify the website domain ownership. As part of the verification TXT record, this parameter is returned for websites that use CNAME setup.'."\n", - 'type' => 'string', - 'example' => 'verify_d516cb3740f81f0cef77d162edd1****', - 'title' => '', - ], + 'AccessType' => ['description' => 'The access type of the site. Valid values:'."\n" + ."\n" + .'- **NS**: Access via NS.'."\n" + ."\n" + .'- **CNAME**: Access via CNAME.', 'type' => 'string', 'example' => 'NS', 'title' => ''], + 'CnameZone' => ['description' => 'For sites onboarded via CNAME, use this suffix to configure the CNAME record.', 'type' => 'string', 'example' => 'example.cname.com', 'title' => ''], + 'Coverage' => ['description' => 'The acceleration region. Valid values:'."\n" + ."\n" + .'- **domestic**: Chinese mainland only'."\n" + ."\n" + .'- **global**: Global'."\n" + ."\n" + .'- **overseas**: Global (excluding the Chinese mainland)', 'type' => 'string', 'example' => 'domestic', 'title' => ''], + 'CreateTime' => ['description' => 'The time (in UTC) when the site was created, formatted in ISO 8601 (`yyyy-MM-ddTHH:mm:ssZ`).', 'type' => 'string', 'example' => '2023-12-24T02:01:11Z', 'title' => ''], + 'UpdateTime' => ['description' => 'The time (in UTC) when the site was last updated, formatted in ISO 8601 (`yyyy-MM-ddTHH:mm:ssZ`).', 'type' => 'string', 'example' => '2023-12-24T02:01:11Z', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the plan instance.', 'type' => 'string', 'example' => 'cas-merge-q6h0bv', 'title' => ''], + 'NameServerList' => ['description' => 'A comma-separated list of name servers assigned to the site.', 'type' => 'string', 'example' => 'male1-1.ialicdn.com,female1-1.ialicdn.com', 'title' => ''], + 'PlanName' => ['description' => 'The name of the plan.', 'type' => 'string', 'example' => 'plan-168777532****', 'title' => ''], + 'PlanSpecName' => ['description' => 'The name of the plan specification.', 'type' => 'string', 'example' => 'normal', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg-aek26g6i6se****', 'title' => ''], + 'SiteId' => ['description' => 'The ID of the site.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''], + 'SiteName' => ['description' => 'The name of the site.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'Status' => ['description' => 'The status of the site. Valid values:'."\n" + ."\n" + .'- **pending**: The site is pending configuration.'."\n" + ."\n" + .'- **active**: The site is active.'."\n" + ."\n" + .'- **offline**: The site is offline.'."\n" + ."\n" + .'- **moved**: The site has been superseded.', 'type' => 'string', 'example' => 'pending', 'title' => ''], + 'Tags' => ['description' => 'The tags of the site.', 'type' => 'object', 'example' => '{"tag1":"value1"}', 'title' => ''], + 'VerifyCode' => ['description' => 'For sites onboarded via CNAME, you must configure this code as a TXT record.', 'type' => 'string', 'example' => 'verify_d516cb3740f81f0cef77d162edd1****', 'title' => ''], 'VanityNSList' => [ - 'description' => 'The information about custom nameservers of the website domain. The key is a custom nameserver name, and the value is the IP address of the custom nameserver. Multiple IP addresses are separated by commas (,).'."\n", + 'description' => 'Each key is a custom name server, and its value is a comma-separated list of the server\'s IP addresses.', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'ns1.example.com', - 'description' => 'The custom nameserver name.'."\n", - 'title' => '', - ], + 'additionalProperties' => ['description' => 'The name of a custom name server.', 'type' => 'string', 'example' => 'ns1.example.com', 'title' => ''], 'title' => '', 'example' => '', ], - 'VersionManagement' => [ - 'description' => 'The status of version management. If true is returned, version management is enabled for the website.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], - 'OfflineReason' => [ - 'description' => 'Reason for site deactivation. Valid values:'."\n" - ."\n" - .'- **expiration_arrears**: Subscription plan expired or account has an overdue payment.'."\n" - .'- **internally_disabled**: Disabled internally by the system.'."\n" - .'- **missing_icp**: Domain name lacks an ICP filing.'."\n" - .'- **content_violation**: Content violation.'."\n" - .'- **proactively_disabled**: You manually disabled the site or usage reached the cap you set.', - 'type' => 'string', - 'example' => 'expiration_ arrears', - 'title' => '', - ], + 'VersionManagement' => ['description' => 'If `true`, version management is enabled for the site.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'OfflineReason' => ['description' => 'The reason the site is offline. This parameter appears only when `Status` is `offline`. Valid values:'."\n" + ."\n" + .'- **expiration\\_arrears**: The subscription plan has expired or the account has overdue payments.'."\n" + ."\n" + .'- **internally\\_disabled**: The site was disabled by the system.'."\n" + ."\n" + .'- **missing\\_icp**: The domain is missing an ICP license.'."\n" + ."\n" + .'- **content\\_violation**: The site violated content policies.'."\n" + ."\n" + .'- **proactively\\_disabled**: The site was disabled either by you or by a usage limit that you configured.', 'type' => 'string', 'example' => 'expiration_ arrears', 'title' => ''], ], 'title' => '', 'example' => '', ], ], - 'description' => 'Response result of the request.', + 'description' => 'The response body.', 'title' => '', 'example' => '', ], @@ -49449,36 +28060,19 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query information of a single site', - 'summary' => 'Query the information of a single site by site ID.', + 'summary' => 'Retrieves the details of a site by its ID.', 'changeSet' => [ - [ - 'createdAt' => '2025-02-18T05:59:13.000Z', - 'description' => 'Response parameters changed', - ], - [ - 'createdAt' => '2024-09-18T08:21:56.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-02-18T05:59:13.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-09-18T08:21:56.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetSite', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSite'], ], ], 'ramActions' => [ @@ -49489,12 +28083,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -49503,12 +28092,8 @@ ], 'GetSiteCurrentNS' => [ 'summary' => 'Queries the nameservers configured for a website.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -49521,22 +28106,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239622', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID. It can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID. It can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], ], 'responses' => [ @@ -49547,21 +28123,11 @@ 'NSList' => [ 'description' => 'The nameservers of the website.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The nameserver name.'."\n", - 'type' => 'string', - 'example' => 'ns1.example.com', - 'title' => '', - ], + 'items' => ['description' => 'The nameserver name.'."\n", 'type' => 'string', 'example' => 'ns1.example.com', 'title' => ''], 'title' => '', 'example' => '', ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2430E05E-1340-5773-B5E1-B743929F46F2', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2430E05E-1340-5773-B5E1-B743929F46F2', 'title' => ''], ], 'description' => '', 'title' => '', @@ -49571,37 +28137,19 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter.SiteName', - 'errorMessage' => 'Invalid website name. Specify a valid name that contains letters and digits and does not contain special characters.', - 'description' => 'Invalid website name. Specify a valid name that contains letters and digits and does not contain special characters.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.SiteName', 'errorMessage' => 'Invalid website name. Specify a valid name that contains letters and digits and does not contain special characters.', 'description' => 'Invalid website name. Specify a valid name that contains letters and digits and does not contain special characters.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NSList\\": [\\n \\"ns1.example.com\\"\\n ],\\n \\"RequestId\\": \\"2430E05E-1340-5773-B5E1-B743929F46F2\\"\\n}","type":"json"}]', 'title' => 'GetSiteCurrentNS', 'changeSet' => [ - [ - 'createdAt' => '2024-09-18T08:21:56.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-18T08:21:56.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetSiteCurrentNS', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSiteCurrentNS'], ], ], 'ramActions' => [ @@ -49612,12 +28160,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -49629,12 +28172,8 @@ ], 'GetSiteCustomLog' => [ 'summary' => 'Queries the configuration of custom log fields for a website.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -49646,22 +28185,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239137', - 'abilityTreeNodes' => [ - 'FEATUREdcdn9K10I1', - ], + 'abilityTreeNodes' => ['FEATUREdcdn9K10I1'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11223***', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11223***', 'title' => ''], ], ], 'responses' => [ @@ -49671,26 +28201,9 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6befa4aa-2a94-4f51-a245-295787192d2c', - ], - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '167026711***', - 'title' => '', - ], - 'ConfigId' => [ - 'description' => 'The ID of the custom log field configuration.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6befa4aa-2a94-4f51-a245-295787192d2c', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6befa4aa-2a94-4f51-a245-295787192d2c'], + 'SiteId' => ['description' => 'The website ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '167026711***', 'title' => ''], + 'ConfigId' => ['description' => 'The ID of the custom log field configuration.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '6befa4aa-2a94-4f51-a245-295787192d2c', 'title' => ''], 'LogCustomField' => [ 'description' => 'The custom fields.'."\n", 'type' => 'object', @@ -49698,36 +28211,21 @@ 'RequestHeaders' => [ 'description' => 'The request header fields.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The request header.'."\n", - 'type' => 'string', - 'example' => 'x-acs-request-id', - 'title' => '', - ], + 'items' => ['description' => 'The request header.'."\n", 'type' => 'string', 'example' => 'x-acs-request-id', 'title' => ''], 'title' => '', 'example' => '', ], 'ResponseHeaders' => [ 'description' => 'The response header fields.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The response header.'."\n", - 'type' => 'string', - 'example' => 'X_Swift_Error', - 'title' => '', - ], + 'items' => ['description' => 'The response header.'."\n", 'type' => 'string', 'example' => 'X_Swift_Error', 'title' => ''], 'title' => '', 'example' => '', ], 'Cookies' => [ 'description' => 'The cookie fields.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The cookie.'."\n", - 'type' => 'string', - 'example' => 'sessionId', - 'title' => '', - ], + 'items' => ['description' => 'The cookie.'."\n", 'type' => 'string', 'example' => 'sessionId', 'title' => ''], 'title' => '', 'example' => '', ], @@ -49735,12 +28233,7 @@ 'title' => '', 'example' => '', ], - 'IsExist' => [ - 'description' => 'Indicates whether the custom configuration exists.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], + 'IsExist' => ['description' => 'Indicates whether the custom configuration exists.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], @@ -49748,40 +28241,22 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'GetSiteCustomLog', 'description' => '* **Description**: You can call this operation to query the configuration of custom log fields for a website, including custom fields in request headers, response headers, and cookies.'."\n" .'* **Scenarios**: You can call this operation in scenarios where you need to obtain specific HTTP headers or cookie information for log analysis.'."\n" .'* ****'."\n", 'changeSet' => [ - [ - 'createdAt' => '2024-09-27T05:57:03.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-27T05:57:03.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetSiteCustomLog', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSiteCustomLog'], ], ], 'ramActions' => [ @@ -49792,12 +28267,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -49809,13 +28279,9 @@ ], ], 'GetSiteDeliveryTask' => [ - 'summary' => 'Queries a real-time log delivery task.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Retrieves the details of a real-time log delivery task.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -49828,146 +28294,69 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239221', - 'abilityTreeNodes' => [ - 'FEATUREdcdn9K10I1', - ], + 'abilityTreeNodes' => ['FEATUREdcdn9K10I1'], ], 'parameters' => [ [ 'name' => 'TaskName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the delivery task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cdn-test-task', - 'title' => '', - ], + 'schema' => ['description' => 'The task name.', 'type' => 'string', 'required' => true, 'example' => 'cdn-test-task', 'title' => ''], ], [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123456***', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the site. Call the [ListSites](~~2850189~~) API to obtain the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', - ], - 'TaskName' => [ - 'description' => 'The name of the delivery task.'."\n", - 'type' => 'string', - 'example' => 'cdn-test-task', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'test.***.com', - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456****', - 'title' => '', - ], - 'DiscardRate' => [ - 'description' => 'The discard rate.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0', - 'title' => '', - ], - 'DataCenter' => [ - 'description' => 'The data center. Valid values:'."\n" - ."\n" - .'1. cn: the Chinese mainland.'."\n" - .'2. sg: outside the Chinese mainland.'."\n", - 'type' => 'string', - 'example' => 'cn', - 'title' => '', - ], - 'BusinessType' => [ - 'description' => 'The log category. Valid values:'."\n" - ."\n" - .'* dcdn_log_access_l1 (default): access logs.'."\n" - .'* dcdn_log_er: Edge Routine logs.'."\n" - .'* dcdn_log_waf: firewall logs.'."\n" - .'* dcdn_log_ipa: TCP/UDP proxy logs.'."\n", - 'type' => 'string', - 'example' => 'dcdn_log_access_l1', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the delivery task.'."\n" - ."\n" - .'* **online**'."\n" - .'* **offline**'."\n", - 'type' => 'string', - 'example' => 'online', - 'title' => '', - ], - 'DeliveryType' => [ - 'description' => 'The destination of the delivery. Valid values:'."\n" - ."\n" - .'1. sls: Alibaba Cloud Simple Log Service (SLS).'."\n" - .'2. http: HTTP server.'."\n" - .'3. aws3: Amazon Simple Storage Service (S3).'."\n" - .'4. oss: Alibaba Cloud Object Storage Service (OSS).'."\n" - .'5. kafka: Kafka.'."\n" - .'6. aws3cmpt: S3-compatible storage service.'."\n", - 'type' => 'string', - 'example' => 'sls', - 'title' => '', - ], - 'FieldList' => [ - 'description' => 'The log fields.'."\n", - 'type' => 'string', - 'example' => 'Client,UserAgent', - 'title' => '', - ], - 'FilterRules' => [ - 'description' => 'The filtering rules.'."\n", - 'type' => 'string', - 'example' => '[]', - 'title' => '', - ], - 'SinkConfig' => [ - 'description' => 'The delivery configuration.'."\n", - 'type' => 'any', - 'example' => '{\'Region\': \'cn-hangzhou\', \'Endpoint\': \'https://***.oss-cn-hangzhou.aliyuncs.com\', \'BucketPath\': \'hjy-test002/online-logs\'}', - 'title' => '', - ], - 'RawRule' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'FilterVer' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD'], + 'TaskName' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'cdn-test-task', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'test.***.com', 'title' => ''], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456****', 'title' => ''], + 'DiscardRate' => ['description' => 'The discard rate.', 'type' => 'number', 'format' => 'float', 'example' => '0.0', 'title' => ''], + 'DataCenter' => ['description' => 'The data center. Valid values:'."\n" + ."\n" + .'- **cn**: Chinese mainland.'."\n" + ."\n" + .'- **sg**: Global (excluding Chinese mainland). Note that the value for this region is "sg".', 'type' => 'string', 'example' => 'cn', 'title' => ''], + 'BusinessType' => ['description' => 'The type of real-time log for Dynamic Route for CDN (DCDN). Valid values:'."\n" + ."\n" + .'- **dcdn\\_log\\_access\\_l1** (default): access log.'."\n" + ."\n" + .'- **dcdn\\_log\\_er**: edge function log.'."\n" + ."\n" + .'- **dcdn\\_log\\_waf**: WAF log.'."\n" + ."\n" + .'- **dcdn\\_log\\_ipa**: layer 4 acceleration log.', 'type' => 'string', 'example' => 'dcdn_log_access_l1', 'title' => ''], + 'Status' => ['description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'- **online**: The task is delivering logs.'."\n" + ."\n" + .'- **offline**: The task is paused.', 'type' => 'string', 'example' => 'online', 'title' => ''], + 'DeliveryType' => ['description' => 'The delivery type. Valid values:'."\n" + ."\n" + .'- **sls**: Log Service.'."\n" + ."\n" + .'- **http**: HTTP service.'."\n" + ."\n" + .'- **aws3**: Amazon S3.'."\n" + ."\n" + .'- **oss**: Object Storage Service.'."\n" + ."\n" + .'- **kafka**: Kafka service.'."\n" + ."\n" + .'- **aws3cmpt**: Amazon S3-compatible service.', 'type' => 'string', 'example' => 'sls', 'title' => ''], + 'FieldList' => ['description' => 'A comma-separated list of log fields to deliver.', 'type' => 'string', 'example' => 'Client,UserAgent', 'title' => ''], + 'FilterRules' => ['description' => 'The filter rules.', 'type' => 'string', 'example' => '[]', 'title' => ''], + 'SinkConfig' => ['description' => 'The delivery configuration.', 'type' => 'any', 'example' => '{\'Region\': \'cn-hangzhou\', \'Endpoint\': \'https://***.oss-cn-hangzhou.aliyuncs.com\', \'BucketPath\': \'hjy-test002/online-logs\'}', 'title' => ''], + 'RawRule' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'FilterVer' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'example' => '', ], @@ -49975,158 +28364,98 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - '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"}]', 'title' => 'GetSiteDeliveryTask', 'changeSet' => [ - [ - 'createdAt' => '2025-06-24T01:43:10.000Z', - 'description' => 'Response parameters changed', - ], - [ - 'createdAt' => '2024-09-27T05:57:03.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-06-24T01:43:10.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-09-27T05:57:03.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetSiteDeliveryTask', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSiteDeliveryTask'], ], ], 'ramActions' => [ [ - 'operationType' => 'none', + 'operationType' => 'get', 'ramAction' => [ 'action' => 'esa:GetSiteDeliveryTask', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => 'Queries the remaining quota for delivering a specific category of real-time logs in a website.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239188', - 'abilityTreeNodes' => [ - 'FEATUREdcdn9K10I1', - ], + 'abilityTreeNodes' => ['FEATUREdcdn9K10I1'], ], 'parameters' => [ [ 'name' => 'BusinessType', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '', - 'description' => 'The log category. Valid values:'."\n" - ."\n" - .'1. dcdn_log_access_l1 (default): access logs.'."\n" - .'2. dcdn_log_er: Edge Routine logs.'."\n" - .'3. dcdn_log_waf: firewall logs.'."\n" - .'4. dcdn_log_ipa: TCP/UDP proxy logs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dcdn_log_access_l1', - ], + 'schema' => ['description' => 'The log category. Valid values:'."\n" + ."\n" + .'1. dcdn\\_log\\_access\\_l1 (default): access logs.'."\n" + ."\n" + .'2. dcdn\\_log\\_er: Edge Routine logs.'."\n" + ."\n" + .'3. dcdn\\_log\\_waf: firewall logs.'."\n" + ."\n" + .'4. dcdn\\_log\\_ipa: TCP/UDP proxy logs.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'dcdn_log_access_l1'], ], [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4C14840EF0EAAB6D97CDE0C5F6554ACE', - ], - 'FreeQuota' => [ - 'description' => 'The remaining quota.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - 'title' => '', - ], - 'BusinessType' => [ - 'description' => 'The log category. Valid values:'."\n" - ."\n" - .'1. dcdn_log_access_l1 (default): access logs.'."\n" - .'2. dcdn_log_er: Edge Routine logs.'."\n" - .'3. dcdn_log_waf: firewall logs.'."\n" - .'4. dcdn_log_ipa: TCP/UDP proxy logs.'."\n", - 'type' => 'string', - 'example' => 'dcdn_log_access_l1', - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456****', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4C14840EF0EAAB6D97CDE0C5F6554ACE'], + 'FreeQuota' => ['description' => 'The remaining quota.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'BusinessType' => ['description' => 'The log category. Valid values:'."\n" + ."\n" + .'1. dcdn\\_log\\_access\\_l1 (default): access logs.'."\n" + ."\n" + .'2. dcdn\\_log\\_er: Edge Routine logs.'."\n" + ."\n" + .'3. dcdn\\_log\\_waf: firewall logs.'."\n" + ."\n" + .'4. dcdn\\_log\\_ipa: TCP/UDP proxy logs.', 'type' => 'string', 'example' => 'dcdn_log_access_l1', 'title' => ''], + 'SiteId' => ['description' => 'The website ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456****', 'title' => ''], ], 'example' => '', ], @@ -50134,48 +28463,35 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C14840EF0EAAB6D97CDE0C5F6554ACE\\",\\n \\"FreeQuota\\": 3,\\n \\"BusinessType\\": \\"dcdn_log_access_l1\\",\\n \\"SiteId\\": 0\\n}","type":"json"}]', 'title' => 'GetSiteLogDeliveryQuota', - 'description' => 'You can call this operation to query the remaining quota for delivering a specific category of real-time logs in a website within an Alibaba Cloud account. This is essential for monitoring and managing your log delivery capacity to ensure that logs can be delivered to the destination and prevent data loss or latency caused by insufficient quota.'."\n" + 'description' => 'Use this operation to query the remaining quota for delivering a specific category of real-time logs in a website within an Alibaba Cloud account. This is essential for monitoring and managing your log delivery capacity to ensure that logs can be delivered to the destination and prevent data loss or latency caused by insufficient quota.'."\n" ."\n" .'**Take note of the following parameters:**'."\n" ."\n" - .'* ``'."\n" - .'* `BusinessType` is required. You must specify a log category to obtain the corresponding quota information.'."\n" - .'* `SiteId` specifies the ID of a website, which must be a valid integer that corresponds to a website that you configured on Alibaba Cloud.'."\n" + .'- \\`\\`'."\n" + ."\n" + .'- `BusinessType` is required. You must specify a log category to obtain the corresponding quota information.'."\n" + ."\n" + .'- `SiteId` specifies the ID of a website, which must be a valid integer that corresponds to a website that you configured on Alibaba Cloud.'."\n" ."\n" .'**Response:**'."\n" ."\n" - .'* If a request is successful, the system returns the remaining log delivery quota (`FreeQuota`), request ID (`RequestId`), website ID (`SiteId`), and log category (`BusinessType`). You can confirm and record the returned data.'."\n", + .'- If a request is successful, the system returns the remaining log delivery quota (`FreeQuota`), request ID (`RequestId`), website ID (`SiteId`), and log category (`BusinessType`). You can confirm and record the returned data.', 'changeSet' => [ - [ - 'createdAt' => '2024-09-27T05:57:03.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-27T05:57:03.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetSiteLogDeliveryQuota', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSiteLogDeliveryQuota'], ], ], 'ramActions' => [ @@ -50186,30 +28502,17 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'operationType' => 'read', - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C14840EF0EAAB6D97CDE0C5F6554ACE\\",\\n \\"FreeQuota\\": 3,\\n \\"BusinessType\\": \\"dcdn_log_access_l1\\",\\n \\"SiteId\\": 0\\n}","type":"json"}]', ], 'GetSiteNameExclusive' => [ 'summary' => 'Queries the site hold configuration of a website. After you enable site hold, other accounts cannot add your website domain or its subdomains to ESA.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -50221,22 +28524,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257455', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], ], 'responses' => [ @@ -50246,22 +28540,14 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '35C66C7B-671H-4297-9187-2C4477247A78', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '35C66C7B-671H-4297-9187-2C4477247A78'], 'Enable' => [ 'description' => 'Indicates whether site hold is enabled. Valid values:'."\n" ."\n" .'* on'."\n" .'* off'."\n", 'type' => 'string', - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], + 'enumValueTitles' => ['off' => 'off', 'on' => 'on'], 'example' => 'on', 'title' => '', ], @@ -50272,27 +28558,16 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35C66C7B-671H-4297-9187-2C4477247A78\\",\\n \\"Enable\\": \\"on\\"\\n}","type":"json"}]', 'title' => 'GetSiteNameExclusive', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetSiteNameExclusive', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSiteNameExclusive'], ], ], 'ramActions' => [ @@ -50303,12 +28578,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -50316,13 +28586,9 @@ 'operationType' => 'read', ], 'GetSiteOriginClientCertificate' => [ - 'summary' => 'Obtain origin fetch client certificate information at the site granularity.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Retrieves the back-to-origin client certificate information at the site level.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -50335,171 +28601,55 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '261746', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'babaabcd****', - 'title' => '', - ], + 'schema' => ['description' => 'The certificate ID.', 'type' => 'string', 'required' => true, 'example' => 'babaabcd****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'SiteId' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456789****', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the certificate.', - 'type' => 'string', - 'example' => 'OK', - 'title' => '', - ], - 'Certificate' => [ - 'description' => 'The certificate content.'."\n", - 'type' => 'string', - 'example' => '-----BEGIN CERTIFICATE-----', - 'title' => '', - ], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789****', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'Status' => ['description' => 'The certificate status.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Certificate' => ['description' => 'The certificate content.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----', 'title' => ''], 'Result' => [ - 'description' => 'The certificate information.'."\n", + 'description' => 'The certificate information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'example' => 'babaabcd****', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The certificate name.'."\n", - 'type' => 'string', - 'example' => 'yourCertName', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the certificate.', - 'type' => 'string', - 'example' => 'OK', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The certificate type.'."\n", - 'type' => 'string', - 'example' => 'upload', - 'title' => '', - ], - 'CommonName' => [ - 'description' => 'The Common Name of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com', - 'title' => '', - ], - 'NotBefore' => [ - 'description' => 'The time when the certificate takes effect.'."\n", - 'type' => 'string', - 'example' => '2023-03-31 02:08:00', - 'title' => '', - ], - 'NotAfter' => [ - 'description' => 'The time when the certificate expires.'."\n", - 'type' => 'string', - 'example' => '2024-03-31 02:08:00', - 'title' => '', - ], - 'Issuer' => [ - 'description' => 'The certificate authority (CA) that issued the certificate.'."\n", - 'type' => 'string', - 'example' => 'DigiCert', - 'title' => '', - ], - 'SAN' => [ - 'description' => 'The Subject Alternative Name (SAN) of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com,*.example.com', - 'title' => '', - ], - 'SignatureAlgorithm' => [ - 'description' => 'The signature algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'SHA256-RSA', - 'title' => '', - ], - 'PubkeyAlgorithm' => [ - 'description' => 'The public-key algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'RSA', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the certificate was created.'."\n", - 'type' => 'string', - 'example' => '2024-06-24 07:48:51', - 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'The time when the certificate was updated.'."\n", - 'type' => 'string', - 'example' => '2024-07-20 06:18:42', - 'title' => '', - ], - 'SerialNumber' => [ - 'description' => 'The serial number of the certificate.'."\n", - 'type' => 'string', - 'example' => 'babab022c5e9b27bf9c64d7f4b16****', - 'title' => '', - ], - 'FingerprintSha256' => [ - 'description' => 'The SHA-256 fingerprint of the certificate.'."\n", - 'type' => 'string', - 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', - 'title' => '', - ], + 'Id' => ['description' => 'The certificate ID.', 'type' => 'string', 'example' => 'babaabcd****', 'title' => ''], + 'Name' => ['description' => 'The certificate name.', 'type' => 'string', 'example' => 'yourCertName', 'title' => ''], + 'Status' => ['description' => 'The certificate status.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Type' => ['description' => 'The certificate type.', 'type' => 'string', 'example' => 'upload', 'title' => ''], + 'CommonName' => ['description' => 'The common name of the certificate.', 'type' => 'string', 'example' => 'www.example.com', 'title' => ''], + 'NotBefore' => ['description' => 'The start time of the certificate validity period. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2023-03-31 02:08:00', 'title' => ''], + 'NotAfter' => ['description' => 'The end time of the certificate validity period. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-03-31 02:08:00', 'title' => ''], + 'Issuer' => ['description' => 'The certification authority that issued the certificate.', 'type' => 'string', 'example' => 'DigiCert', 'title' => ''], + 'SAN' => ['description' => 'The Subject Alternative Name (SAN) of the certificate.', 'type' => 'string', 'example' => 'www.example.com,*.example.com', 'title' => ''], + 'SignatureAlgorithm' => ['description' => 'The signature algorithm of the certificate.', 'type' => 'string', 'example' => 'SHA256-RSA', 'title' => ''], + 'PubkeyAlgorithm' => ['description' => 'The public key algorithm of the certificate.', 'type' => 'string', 'example' => 'RSA', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-06-24 07:48:51', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-07-20 06:18:42', 'title' => ''], + 'SerialNumber' => ['description' => 'The certificate serial number.', 'type' => 'string', 'example' => 'babab022c5e9b27bf9c64d7f4b16****', 'title' => ''], + 'FingerprintSha256' => ['description' => 'The SHA-256 fingerprint of the certificate.', 'type' => 'string', 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', 'title' => ''], ], 'title' => '', 'example' => '', ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', 'title' => ''], ], 'example' => '', ], @@ -50507,62 +28657,26 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'Id.MissingParameter', - 'errorMessage' => 'The parameter Id is required.', - 'description' => 'The required parameter Id is missing.', - ], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'Id.MissingParameter', 'errorMessage' => 'The parameter Id is required.', 'description' => 'The required parameter Id is missing.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'Certificate.NotFound', - 'errorMessage' => 'The specified certificate does not exist.', - 'description' => 'The specified certificate does not exist.', - ], + ['errorCode' => 'Certificate.NotFound', 'errorMessage' => 'The specified certificate does not exist.', 'description' => 'The specified certificate does not exist.'], ], ], - 'title' => 'Obtain origin fetch client certificate information with site granularity', + '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"}]', + 'title' => 'Retrieve site-level back-to-origin client certificate information', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '20', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetSiteOriginClientCertificate', - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSiteOriginClientCertificate'], ], ], 'ramActions' => [ @@ -50573,78 +28687,53 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => [ - 'summary' => 'Queries the ESA proxy configuration of a website.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the site pause configuration.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257463', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. Call the [ListSites](~~ListSites~~) operation to obtain this ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n", - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n"], 'Paused' => [ - 'description' => 'Indicates whether ESA is paused on the website. Valid values:'."\n" + 'description' => 'Indicates whether site acceleration is paused. Valid values:'."\n" ."\n" - .'* true'."\n" - .'* false'."\n", + .'- true: The site\'s acceleration is paused.'."\n" + ."\n" + .'- false: The site is accelerating normally.', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], 'example' => 'true', 'title' => '', ], @@ -50655,27 +28744,17 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\\\n\\",\\n \\"Paused\\": true\\n}","type":"json"}]', 'title' => 'GetSitePause', + 'description' => 'This API applies only to sites that use NS mode.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetSitePause', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSitePause'], ], ], 'ramActions' => [ @@ -50686,27 +28765,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'operationType' => 'read', ], 'GetSiteWafSettings' => [ 'summary' => 'Get WAF Configuration for a Site', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -50719,49 +28787,27 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239627', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4VDL9A', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4VDL9A'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'title' => '站点ID', - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '站点ID', 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) API.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Site version.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'Site version.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'Path', 'in' => 'query', 'schema' => [ 'description' => 'Specifies the configuration path. If not provided, all configurations will be retrieved.', + 'enumValueTitles' => ['bot_management' => 'Simple Mode Bots', 'add_security_headers' => 'Adding security response headers', 'client_ip_identifier' => 'Client IP Definition', 'add_bot_protection_headers' => 'Adding security request headers', 'security_level' => 'Security Level'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'bot_management' => 'Simple Mode Bots', - 'add_security_headers' => 'Adding security response headers', - 'client_ip_identifier' => 'Client IP Definition', - 'add_bot_protection_headers' => 'Adding security request headers', - 'security_level' => 'Security Level', - ], 'example' => 'bot_management', 'title' => '', ], @@ -50774,18 +28820,8 @@ 'description' => 'Response result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], - 'Settings' => [ - 'title' => '站点WAF配置', - 'description' => 'Details of site WAF configuration.', - '$ref' => '#/components/schemas/WafSiteSettings', - 'example' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], + 'Settings' => ['title' => '站点WAF配置', 'description' => 'Details of site WAF configuration.', '$ref' => '#/components/schemas/WafSiteSettings', 'example' => ''], ], 'example' => '', ], @@ -50793,45 +28829,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Get WAF Configuration for a Site', 'changeSet' => [ - [ - 'createdAt' => '2024-12-12T06:17:42.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-09-25T07:02:51.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T08:21:55.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-12-12T06:17:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-25T07:02:51.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T08:21:55.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetSiteWafSettings', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSiteWafSettings'], ], ], 'ramActions' => [ @@ -50842,25 +28853,17 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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 \\"Mode\\": \\"headers\\",\\n \\"Headers\\": [\\n \\"X-Forwarded-For\\"\\n ]\\n },\\n \\"AddBotProtectionHeaders\\": {\\n \\"Enable\\": false\\n },\\n \\"AddSecurityHeaders\\": {\\n \\"Enable\\": false\\n },\\n \\"SecurityLevel\\": {\\n \\"Value\\": \\"low\\"\\n },\\n \\"BotManagement\\": {\\n \\"DefiniteBots\\": {\\n \\"Id\\": 20000001,\\n \\"Action\\": \\"captcha\\"\\n },\\n \\"LikelyBots\\": {\\n \\"Id\\": 20000002,\\n \\"Action\\": \\"deny\\"\\n },\\n \\"VerifiedBots\\": {\\n \\"Id\\": 20000003,\\n \\"Action\\": \\"bypass\\"\\n },\\n \\"JSDetection\\": {\\n \\"Enable\\": false\\n },\\n \\"EffectOnStatic\\": {\\n \\"Enable\\": true\\n }\\n },\\n \\"BandwidthAbuseProtection\\": {\\n \\"Id\\": 10000001,\\n \\"Status\\": \\"on\\",\\n \\"Action\\": \\"deny\\"\\n },\\n \\"DisableSecurityModule\\": {\\n \\"Status\\": \\"on\\"\\n },\\n \\"RequestBodyInspection\\": {\\n \\"Id\\": 0,\\n \\"SizeLimit\\": \\"\\",\\n \\"Action\\": \\"\\"\\n }\\n }\\n}","type":"json"}]', ], 'GetTieredCache' => [ 'summary' => 'Query Multi-level Cache Configuration for Site', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -50872,22 +28875,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257309', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], ], 'responses' => [ @@ -50897,12 +28891,7 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74'], 'CacheArchitectureMode' => [ 'description' => 'Multi-level cache architecture mode. Possible values:'."\n" .'- edge: Edge cache layer.'."\n" @@ -50910,12 +28899,7 @@ .'- edge_regional: Edge cache layer + regional cache layer.'."\n" .'- edge_regional_smart: Edge cache layer + regional cache layer + intelligent cache layer.', 'type' => 'string', - 'enumValueTitles' => [ - 'edge_smart' => 'edge_smart', - 'edge' => 'edge', - 'edge_regional' => 'edge_regional', - 'edge_regional_smart' => 'edge_regional_smart', - ], + 'enumValueTitles' => ['edge_smart' => 'edge_smart', 'edge' => 'edge', 'edge_regional' => 'edge_regional', 'edge_regional_smart' => 'edge_regional_smart'], 'example' => 'edge', 'title' => '', ], @@ -50926,27 +28910,16 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"CacheArchitectureMode\\": \\"edge\\"\\n}","type":"json"}]', 'title' => 'Query Multi-level Cache Configuration for Site', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetTieredCache', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTieredCache'], ], ], 'ramActions' => [ @@ -50957,12 +28930,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -50970,13 +28938,9 @@ 'operationType' => 'read', ], 'GetTransportLayerApplication' => [ - 'summary' => 'Query details of the transport layer application', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the details of a Layer 4 application.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -50989,149 +28953,63 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '245120', - 'abilityTreeNodes' => [ - 'FEATUREdcdn2E10XY', - ], + 'abilityTreeNodes' => ['FEATUREdcdn2E10XY'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Transport layer application ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ApplicationId', 'in' => 'query', - 'schema' => [ - 'description' => 'Number of forwarding rules contained in the transport layer acceleration application.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '170997271816****', - 'title' => '', - ], + 'schema' => ['description' => 'The application ID, which can be obtained by calling the [ListTransportLayerApplications](~~ListTransportLayerApplications~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '170997271816****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'List of forwarding rules.', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'EB635996-1FD6-5DFD-BA57-27A849599940', - ], - 'SiteId' => [ - 'description' => 'Details of the forwarding rule.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456****', - 'title' => '', - ], - 'ApplicationId' => [ - 'description' => 'Specific value of the origin, which needs to match the type of the origin.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '17099311410****', - 'title' => '', - ], - 'RulesCount' => [ - 'description' => 'Forwarding rule protocol, with values:'."\n" - ."\n" - .'- TCP: TCP protocol.'."\n" - .'- UDP: UDP protocol.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EB635996-1FD6-5DFD-BA57-27A849599940'], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456****', 'title' => ''], + 'ApplicationId' => ['description' => 'The Layer 4 application ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '17099311410****', 'title' => ''], + 'RulesCount' => ['description' => 'The number of forwarding rules in the Layer 4 acceleration application.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Rules' => [ - 'description' => 'Edge port. Supports:'."\n" - ."\n" - .'- A single port, such as 80.'."\n" - .'- Port range, such as 81-85, representing ports 81, 82, 83, 84, 85.'."\n" - .'- Combination of ports and port ranges, separated by commas, for example 80,81-85,90, representing ports 80, 81, 82, 83, 84, 85, 90.', + 'description' => 'The list of forwarding rules.', 'type' => 'array', 'items' => [ - 'description' => 'Origin type, supporting:'."\n" - .'- **ip**: IP.'."\n" - .'- **domain**: Domain name.'."\n" - .'- **OP**: Origin pool.'."\n" - .'- **LB**: Load balancer.', + 'description' => 'The forwarding rule details.', 'type' => 'object', 'properties' => [ - 'Source' => [ - 'description' => 'Origin port. Supports:'."\n" - ."\n" - .'- A single port, when the origin port is a single port, any valid edge port combination is supported.'."\n" - .'- Port range, only when the edge port is a port range, the origin port can be set as a port range and the size of the range must be consistent with the edge port. For example, if the edge port is 90-93, the origin port cannot be set to 81-85 because the origin port range is 5 and the edge port range is 3, which are inconsistent.', - 'type' => 'string', - 'example' => '1.1.1.1', - 'title' => '', - ], - 'Protocol' => [ - 'description' => 'Client IP pass-through protocol, supporting:'."\n" - .'- **off**: No pass-through.'."\n" - .'- **PPv1**: PROXY Protocol v1, supports client IP pass-through for TCP protocol.'."\n" - .'- **PPv2**: PROXY Protocol v2, supports client IP pass-through for TCP and UDP protocols.'."\n" - .'- **SPP**: Simple Proxy Protocol, supports client IP pass-through for UDP protocol.', - 'type' => 'string', - 'example' => 'TCP', - 'title' => '', - ], - 'EdgePort' => [ - 'description' => 'Comment information of the rule.', - 'type' => 'string', - 'example' => '80', - 'title' => '', - ], - 'SourceType' => [ - 'description' => 'Rule ID.', - 'type' => 'string', - 'example' => 'domain', - 'title' => '', - ], - 'SourcePort' => [ - 'description' => 'The CNAME domain corresponding to the transport layer acceleration application. This field is not empty only when the site is accessed via CNAME.', - 'type' => 'string', - 'example' => '80', - 'title' => '', - ], - 'ClientIPPassThroughMode' => [ - 'description' => 'The domain name of the transport layer application.', - 'type' => 'string', - 'example' => 'off', - 'title' => '', - ], - 'Comment' => [ - 'description' => 'Switch for IP access rules. When turned on, the IP access rules in WAF take effect on the transport layer application.'."\n" - ."\n" - .'- on: Turned on.'."\n" - .'- off: Turned off.', - 'type' => 'string', - 'example' => '测试', - 'title' => '', - ], - 'RuleId' => [ - 'description' => 'Status of the transport layer application'."\n" - ."\n" - .'- **deploying**: Deploying. In this state, modification and deletion are not allowed.'."\n" - .'- **active**: Active.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234323***', - 'title' => '', - ], + 'Source' => ['description' => 'The specific value of the origin server, which must match the origin server type.', 'type' => 'string', 'example' => '1.1.1.1', 'title' => ''], + 'Protocol' => ['description' => 'The protocol of the forwarding rule. Valid values:'."\n" + ."\n" + .'- TCP: TCP protocol.'."\n" + .'- UDP: UDP protocol.', 'type' => 'string', 'example' => 'TCP', 'title' => ''], + 'EdgePort' => ['description' => 'The edge port. The following formats are supported:'."\n" + ."\n" + .'- A single port, such as 80.'."\n" + .'- A port range, such as 81-85, which represents ports 81, 82, 83, 84, and 85.'."\n" + .'- A combination of ports and port ranges separated by commas, such as 80,81-85,90, which represents ports 80, 81, 82, 83, 84, 85, and 90.', 'type' => 'string', 'example' => '80', 'title' => ''], + 'SourceType' => ['description' => 'The origin server type. Valid values:'."\n" + .'- **ip**: IP address.'."\n" + .'- **domain**: domain name.'."\n" + .'- **OP**: IPAM pool.'."\n" + .'- **LB**: load balancing.', 'type' => 'string', 'example' => 'domain', 'title' => ''], + 'SourcePort' => ['description' => 'The origin server port. The following formats are supported:'."\n" + ."\n" + .'- A single port. When the origin server port is a single port, any valid edge port combination is supported.'."\n" + .'- A port range. The origin server port can be set to a port range only when the edge port is a port range, and the range size must be the same as the edge port range. For example, if the edge port is 90-93, you cannot set the origin server port to 81-85 because the origin server port range is 5 while the edge port range is 4, which are inconsistent.', 'type' => 'string', 'example' => '80', 'title' => ''], + 'ClientIPPassThroughMode' => ['description' => 'The client IP pass-through protocol. Valid values:'."\n" + .'- **off**: disabled.'."\n" + .'- **PPv1**: PROXY Protocol v1, which supports client IP pass-through for TCP.'."\n" + .'- **PPv2**: PROXY Protocol v2, which supports client IP pass-through for TCP and UDP.'."\n" + .'- **SPP**: Simple Proxy Protocol, which supports client IP pass-through for UDP.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'Comment' => ['description' => 'The comment for the rule.', 'type' => 'string', 'example' => 'Test', 'title' => ''], + 'RuleId' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234323***', 'title' => ''], ], 'title' => '', 'example' => '', @@ -51139,97 +29017,81 @@ 'title' => '', 'example' => '', ], - 'Cname' => [ - 'description' => 'Whether to enable China mainland network access optimization, default is off. Value range:'."\n" + 'Cname' => ['description' => 'The CNAME domain name of the Layer 4 acceleration application. This field is non-empty only when the site is connected by using the CNAME method.', 'type' => 'string', 'example' => 'example.com.ialicdn.com', 'title' => ''], + 'RecordName' => ['description' => 'The domain name of the Layer 4 application.', 'type' => 'string', 'example' => 'test.example.com', 'title' => ''], + 'IpAccessRule' => [ + 'description' => 'The IP access rule switch. When enabled, IP access rules in WAF take effect for the Layer 4 application. Valid values:'."\n" + ."\n" .'- on: Enabled.'."\n" .'- off: Disabled.', - 'type' => 'string', - 'example' => 'example.com.ialicdn.com', - 'title' => '', - ], - 'RecordName' => [ - 'description' => 'Query Transport Layer Acceleration Application', - 'type' => 'string', - 'example' => 'test.example.com', - 'title' => '', - ], - 'IpAccessRule' => [ - 'description' => '#/components/schemas/WafRuleMatch2', - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', 'example' => 'on', 'title' => '', ], 'Ipv6' => [ - 'description' => 'Ipv6 switch', - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], + 'description' => 'The IPv6 switch. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', 'example' => 'on', 'title' => '', ], 'Status' => [ - 'enumValueTitles' => [ - 'deploying' => 'deploying', - 'active' => 'active', - ], - 'type' => 'string', - 'description' => 'Status of the Layer 4 application.'."\n" + 'description' => 'The Layer 4 application status. Valid values:'."\n" ."\n" - .'- **deploying**: Deployment in progress. Modification and deletion are not allowed in this state.'."\n" - .'- **active**: In Effect. ', + .'- **deploying**: Being deployed. Modifications and deletions are not allowed in this state.'."\n" + .'- **active**: Active.', + 'enumValueTitles' => ['deploying' => 'Being deployed.', 'active' => 'Active.'], + 'type' => 'string', 'example' => 'active', 'title' => '', ], 'CrossBorderOptimization' => [ - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], - 'type' => 'string', - 'description' => 'Whether to enable Network optimization for access from mainland China. The default value is off. Valid values:'."\n" + 'description' => 'Specifies whether to enable network access optimization for the Chinese mainland. This feature is disabled by default. Valid values:'."\n" .'- on: Enabled.'."\n" - .'- off: shutdown.', - 'example' => 'on', - 'title' => '', - ], - 'StaticIp' => [ + .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', - 'description' => '', + 'example' => 'on', 'title' => '', - 'example' => '', ], + 'StaticIp' => ['description' => 'Specifies whether to enable static IP. This feature is disabled by default. Valid values:'."\n" + ."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'off', 'title' => ''], 'StaticIpV4List' => [ + 'description' => 'The list of static IPv4 addresses assigned to this Layer 4 application after the static IP feature is enabled.', 'type' => 'array', 'items' => [ + 'description' => 'A single static IPv4 entry, including the IP address and its status.', 'type' => 'object', 'properties' => [ - 'Address' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'Status' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'Address' => ['description' => 'The IP address.', 'type' => 'string', 'example' => '1.1.1.2', 'title' => ''], + 'Status' => ['description' => 'The status of the IP address. Valid values:'."\n" + ."\n" + .'- healthy: Healthy.'."\n" + .'- unhealthy: Unhealthy.'."\n" + .'- unknown: The IP address is being prepared.', 'type' => 'string', 'example' => 'healthy', 'title' => ''], ], - 'description' => '', 'title' => '', 'example' => '', ], - 'description' => '', 'title' => '', 'example' => '', ], + 'KeepAliveProtection' => [ + 'title' => '', + 'description' => 'Specifies whether to enable keep-alive protection. This feature is disabled by default. Valid values:'."\n" + ."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], + 'type' => 'string', + 'enum' => ['on', 'off'], + 'example' => 'off', + ], ], 'title' => '', 'example' => '', @@ -51238,37 +29100,37 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'TransportLayerApplicationNotExist', - 'errorMessage' => 'The layer -4 accelerated application of the current operation does not exist. Modify it and try again.', - 'description' => 'The layer -4 accelerated application of the current operation does not exist. Modify it and try again.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'TransportLayerApplicationNotExist', 'errorMessage' => 'The layer -4 accelerated application of the current operation does not exist. Modify it and try again.', 'description' => 'The layer -4 accelerated application of the current operation does not exist. Modify it and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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"}]', - 'title' => 'Query Transport Layer Acceleration Application', + 'staticInfo' => ['returnType' => 'synchronous'], + '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\\": \\"Test\\",\\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\\": \\"off\\",\\n \\"StaticIpV4List\\": [\\n {\\n \\"Address\\": \\"1.1.1.2\\",\\n \\"Status\\": \\"healthy\\"\\n }\\n ],\\n \\"KeepAliveProtection\\": \\"off\\"\\n}","type":"json"}]', + 'title' => 'Query a layer 4 acceleration application', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTransportLayerApplication'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:GetTransportLayerApplication', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], + ], + ], ], - 'ramActions' => [], ], 'GetUploadTask' => [ - 'summary' => 'Queries the execution status and running information of a file upload task based on the task ID.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the execution status and runtime information of a file upload task by task ID.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -51281,72 +29143,40 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239277', - 'abilityTreeNodes' => [ - 'FEATUREdcdnBCJPGN', - 'FEATUREdcdnRELTJV', - 'FEATUREdcdnEWYS3A', - 'FEATUREdcdn4TTNAL', - ], + 'abilityTreeNodes' => ['FEATUREdcdnBCJPGN', 'FEATUREdcdnRELTJV', 'FEATUREdcdnEWYS3A', 'FEATUREdcdn4TTNAL'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123456****'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n" + .'>This parameter is required when querying an upload task.>.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456****'."\n", 'title' => ''], ], [ 'name' => 'UploadId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the file upload task. This field is assigned after you call the [UploadFile](~~2850466~~) operation.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '159253299357****', - 'title' => '', - ], + 'schema' => ['description' => 'The file upload task ID, which is assigned when you call the [UploadFile](~~2850466~~) operation.'."\n" + .'>This parameter is required and must be a valid task ID returned by the UploadFile operation. If this parameter is not provided or the specified ID does not exist, an InvalidParameters (400) error is returned.>.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '159253299357****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ET5BF670-09D5-4D0B-BEBY-D96A2A52****', - ], - 'Status' => [ - 'description' => 'The task status.'."\n" - ."\n" - .'* **INIT**: The task is being initialized.'."\n" - .'* **activacted**: The task is activated.'."\n" - .'* **running**: The task is running.'."\n" - .'* **success**: The task is successful.'."\n" - .'* **partial**: The task is partially successful.'."\n" - .'* **fail**: The task failed.'."\n", - 'type' => 'string', - 'example' => 'running', - 'title' => '', - ], - 'Description' => [ - 'description' => 'The error message returned when the file upload task failed.'."\n", - 'type' => 'string', - 'example' => 'invalid url', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ET5BF670-09D5-4D0B-BEBY-D96A2A52****'], + 'Status' => ['description' => 'The task status. Valid values:'."\n" + ."\n" + .'- **init**: The task is being initialized.'."\n" + .'- **activacted**: The task is activated.'."\n" + .'- **running**: The task is running.'."\n" + .'- **success**: The task succeeded.'."\n" + .'- **partial**: The task partially succeeded.'."\n" + .'- **fail**: The task failed.', 'type' => 'string', 'example' => 'running', 'title' => ''], + 'Description' => ['description' => 'The error message returned when the file upload task fails.', 'type' => 'string', 'example' => 'invalid url', 'title' => ''], ], 'example' => '', ], @@ -51354,93 +29184,31 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingTimeParameter', - 'errorMessage' => 'The StartTime and EndTime must be both specified.', - 'description' => 'Please provide both a start time and an end time.', - ], - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], - [ - 'errorCode' => 'DomainNameOverLimit', - 'errorMessage' => 'A maximum of 500 domains are supported for each request.', - 'description' => 'Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.', - ], - [ - 'errorCode' => 'InvalidTime', - 'errorMessage' => 'The query time cannot exceed the last 3 days.', - 'description' => 'The query time cannot exceed the last 3 days.', - ], - [ - 'errorCode' => 'MissingParameter.ObjectType', - 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', - 'description' => 'Specify the ObjectType parameter.', - ], - [ - 'errorCode' => 'InvalidStationParameter', - 'errorMessage' => 'The specified Station is invalid.', - 'description' => 'The specified node parameter is invalid.', - ], - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests.Please try again later.', - 'description' => 'Requests are too frequent, please try again later.', - ], - [ - 'errorCode' => 'InvalidTaskId.Malformed', - 'errorMessage' => 'The specified taskId is invalid.', - 'description' => 'The specified task ID is invalid.', - ], - [ - 'errorCode' => 'InvalidParameters.InvalidUrls', - 'errorMessage' => 'The specified urls are invalid.', - 'description' => 'The requested URL parameter is invalid.', - ], + ['errorCode' => 'MissingTimeParameter', 'errorMessage' => 'The StartTime and EndTime must be both specified.', 'description' => 'Please provide both a start time and an end time.'], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'DomainNameOverLimit', 'errorMessage' => 'A maximum of 500 domains are supported for each request.', 'description' => 'Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.'], + ['errorCode' => 'InvalidTime', 'errorMessage' => 'The query time cannot exceed the last 3 days.', 'description' => 'The query time cannot exceed the last 3 days.'], + ['errorCode' => 'MissingParameter.ObjectType', 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', 'description' => 'Specify the ObjectType parameter.'], + ['errorCode' => 'InvalidStationParameter', 'errorMessage' => 'The specified Station is invalid.', 'description' => 'The specified node parameter is invalid.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], + ['errorCode' => 'InvalidTaskId.Malformed', 'errorMessage' => 'The specified taskId is invalid.', 'description' => 'The specified task ID is invalid.'], + ['errorCode' => 'InvalidParameters.InvalidUrls', 'errorMessage' => 'The specified urls are invalid.', 'description' => 'The requested URL parameter is invalid.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ET5BF670-09D5-4D0B-BEBY-D96A2A52****\\",\\n \\"Status\\": \\"running\\",\\n \\"Description\\": \\"invalid url\\"\\n}","type":"json"}]', - 'title' => 'GetUploadTask', + 'title' => 'Query file upload task status', '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}', - ], - ], - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUploadTask'], ], ], + 'ramActions' => [], ], 'GetUserDeliveryTask' => [ - 'summary' => 'Queries the information about a log delivery task by account.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the delivery configuration and status of a task for a specific user.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -51453,124 +29221,59 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239202', - 'abilityTreeNodes' => [ - 'FEATUREdcdn9K10I1', - ], + 'abilityTreeNodes' => ['FEATUREdcdn9K10I1'], ], 'parameters' => [ [ 'name' => 'TaskName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the delivery task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_project', - 'title' => '', - ], + 'schema' => ['description' => 'The task name.', 'type' => 'string', 'required' => true, 'example' => 'test_project', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7072132a-bd3c-46a6-9e81-aba3e0e3f861', - ], - 'TaskName' => [ - 'description' => 'The name of the delivery task.'."\n", - 'type' => 'string', - 'example' => 'testoss11', - 'title' => '', - ], - 'DiscardRate' => [ - 'description' => 'The discard rate.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - 'title' => '', - ], - 'DataCenter' => [ - 'description' => 'The data center. Valid values:'."\n" - ."\n" - .'* cn: the Chinese mainland.'."\n" - .'* sg: outside the Chinese mainland.'."\n", - 'type' => 'string', - 'example' => 'cn', - 'title' => '', - ], - 'BusinessType' => [ - 'description' => 'The log category. Valid values:'."\n" - ."\n" - .'* **dcdn_log_access_l1** (default): access logs.'."\n" - .'* **dcdn_log_er**: Edge Routine logs.'."\n" - .'* **dcdn_log_waf**: firewall logs.'."\n" - .'* **dcdn_log_ipa**: TCP/UDP proxy logs.'."\n", - 'type' => 'string', - 'example' => 'dcdn_log_er', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the delivery task.'."\n", - 'type' => 'string', - 'example' => 'online', - 'title' => '', - ], - 'DeliveryType' => [ - 'description' => 'The destination of the delivery. Valid values:'."\n" - ."\n" - .'* sls: Alibaba Cloud Simple Log Service (SLS).'."\n" - .'* http: HTTP server.'."\n" - .'* aws3: Amazon Simple Storage Service (S3).'."\n" - .'* oss: Alibaba Cloud Object Storage Service (OSS).'."\n" - .'* kafka: Kafka.'."\n" - .'* aws3cmpt: S3-compatible storage service.'."\n", - 'type' => 'string', - 'example' => 'oss', - 'title' => '', - ], - 'FieldList' => [ - 'description' => 'The fields.'."\n", - 'type' => 'string', - 'example' => 'ClientRequestID,ClientRequestHost', - 'title' => '', - ], - 'FilterRules' => [ - 'description' => 'The filtering rules.'."\n", - 'type' => 'string', - 'example' => '[{"ClientSSLProtocol": {"equals": ["TLSv1.3"]}}]', - 'title' => '', - ], - 'SinkConfig' => [ - 'description' => 'The delivery configuration.'."\n", - 'type' => 'any', - 'example' => '{\'Project\': \'er-online-hjy-pro\', \'Logstore\': \'er-online-hjy-log\', \'Region\': \'cn-hangzhou\', \'Endpoint\': \'cn-hangzhou.log.aliyuncs.com\', \'Aliuid\': \'1077912128805410\'}', - 'title' => '', - ], - 'Details' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'RawRule' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'FilterVer' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7072132a-bd3c-46a6-9e81-aba3e0e3f861'], + 'TaskName' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'testoss11', 'title' => ''], + 'DiscardRate' => ['description' => 'The discard rate.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + 'DataCenter' => ['description' => 'The data center. Valid values:'."\n" + ."\n" + .'- **cn**: Chinese mainland'."\n" + ."\n" + .'- **sg**: Global (excluding the Chinese mainland)', 'type' => 'string', 'example' => 'cn', 'title' => ''], + 'BusinessType' => ['description' => 'The business type. Valid values:'."\n" + ."\n" + .'- **dcdn\\_log\\_access\\_l1** (default): access log.'."\n" + ."\n" + .'- **dcdn\\_log\\_er**: edge function log.'."\n" + ."\n" + .'- **dcdn\\_log\\_waf**: WAF log.'."\n" + ."\n" + .'- **dcdn\\_log\\_ipa**: Layer 4 acceleration log.', 'type' => 'string', 'example' => 'dcdn_log_er', 'title' => ''], + 'Status' => ['description' => 'The task status.', 'type' => 'string', 'example' => 'online', 'title' => ''], + 'DeliveryType' => ['description' => 'The delivery type. Valid values:'."\n" + ."\n" + .'- **sls**: Log Service'."\n" + ."\n" + .'- **http**: HTTP service'."\n" + ."\n" + .'- **aws3**: Amazon S3'."\n" + ."\n" + .'- **oss**: OSS'."\n" + ."\n" + .'- **kafka**: Kafka service'."\n" + ."\n" + .'- **aws3cmpt**: Amazon S3-compatible service', 'type' => 'string', 'example' => 'oss', 'title' => ''], + 'FieldList' => ['description' => 'A comma-separated list of fields.', 'type' => 'string', 'example' => 'ClientRequestID,ClientRequestHost', 'title' => ''], + 'FilterRules' => ['description' => 'The filter rules.', 'type' => 'string', 'example' => '[{"ClientSSLProtocol": {"equals": ["TLSv1.3"]}}]', 'title' => ''], + 'SinkConfig' => ['description' => 'The delivery configuration.', 'type' => 'any', 'example' => '{\'Project\': \'er-online-hjy-pro\', \'Logstore\': \'er-online-hjy-log\', \'Region\': \'cn-hangzhou\', \'Endpoint\': \'cn-hangzhou.log.aliyuncs.com\', \'Aliuid\': \'1077912128805410\'}', 'title' => ''], + 'Details' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RawRule' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'FilterVer' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'example' => '', ], @@ -51578,59 +29281,27 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], ], 403 => [ - [ - 'errorCode' => 'EsaService.NotOpen', - 'errorMessage' => 'ESA service has not opend.', - 'description' => 'Edge Security Accelerator (ESA) is not turned on', - ], + ['errorCode' => 'EsaService.NotOpen', 'errorMessage' => 'ESA service has not opend.', 'description' => 'Edge Security Accelerator (ESA) is not turned on'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetUserDeliveryTask', - 'description' => '* This API operation queries the details of a delivery task, including the task name, discard rate, region, log category, status, delivery destination, configuration, and filtering rules.****'."\n" - .'* You can call this operation to query detailed information about a log delivery task to analyze log processing efficiency or troubleshoot delivery problems.****'."\n" - .'* ****````'."\n", + 'description' => '- **Function**: This operation retrieves detailed delivery information for a specific task of an Alibaba Cloud user, including the task name, discard rate, region, business type, status, delivery type, delivery configuration, and filter rules.'."\n" + ."\n" + .'- **Use case**: Use this operation to review the log processing and delivery configuration for a specific task. This helps you analyze processing efficiency or troubleshoot issues.', 'changeSet' => [ - [ - 'createdAt' => '2025-06-24T01:43:11.000Z', - 'description' => 'Response parameters changed', - ], - [ - 'createdAt' => '2024-12-26T08:21:56.000Z', - 'description' => 'Response parameters changed', - ], - [ - 'createdAt' => '2024-10-18T01:07:11.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-27T05:57:03.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-06-24T01:43:11.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-26T08:21:56.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-10-18T01:07:11.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-27T05:57:03.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetUserDeliveryTask', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUserDeliveryTask'], ], ], 'ramActions' => [ @@ -51641,25 +29312,17 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', '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' => 'Queries the remaining log delivery quota of each log category in your account.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -51671,27 +29334,19 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239047', - 'abilityTreeNodes' => [ - 'FEATUREdcdn9K10I1', - ], + 'abilityTreeNodes' => ['FEATUREdcdn9K10I1'], ], 'parameters' => [ [ 'name' => 'BusinessType', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '', - 'description' => 'The log category. Valid values:'."\n" - ."\n" - .'* dcdn_log_access_l1 (default): access logs.'."\n" - .'* dcdn_log_er: Edge Routine logs.'."\n" - .'* dcdn_log_waf: firewall logs.'."\n" - .'* dcdn_log_ipa: TCP/UDP proxy logs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dcdn_log_access_l1', - ], + 'schema' => ['title' => '', 'description' => 'The log category. Valid values:'."\n" + ."\n" + .'* dcdn_log_access_l1 (default): access logs.'."\n" + .'* dcdn_log_er: Edge Routine logs.'."\n" + .'* dcdn_log_waf: firewall logs.'."\n" + .'* dcdn_log_ipa: TCP/UDP proxy logs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'dcdn_log_access_l1'], ], ], 'responses' => [ @@ -51701,30 +29356,14 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', - ], - 'FreeQuota' => [ - 'description' => 'The remaining quota.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - 'title' => '', - ], - 'BusinessType' => [ - 'description' => 'The log category. Valid values:'."\n" - ."\n" - .'* dcdn_log_access_l1 (default): access logs.'."\n" - .'* dcdn_log_er: Edge Routine logs.'."\n" - .'* dcdn_log_waf: firewall logs.'."\n" - .'* dcdn_log_ipa: TCP/UDP proxy logs.'."\n", - 'type' => 'string', - 'example' => 'dcdn_log_access_l1', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD'], + 'FreeQuota' => ['description' => 'The remaining quota.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'BusinessType' => ['description' => 'The log category. Valid values:'."\n" + ."\n" + .'* dcdn_log_access_l1 (default): access logs.'."\n" + .'* dcdn_log_er: Edge Routine logs.'."\n" + .'* dcdn_log_waf: firewall logs.'."\n" + .'* dcdn_log_ipa: TCP/UDP proxy logs.'."\n", 'type' => 'string', 'example' => 'dcdn_log_access_l1', 'title' => ''], ], 'example' => '', ], @@ -51732,45 +29371,23 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], ], 403 => [ - [ - 'errorCode' => 'ErService.NotOpen', - 'errorMessage' => 'Er service has not opend.', - 'description' => 'Er service has not opend.', - ], + ['errorCode' => 'ErService.NotOpen', 'errorMessage' => 'Er service has not opend.', 'description' => 'Er service has not opend.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34DCBC8A-****-****-****-6DAA11D7DDBD\\",\\n \\"FreeQuota\\": 3,\\n \\"BusinessType\\": \\"dcdn_log_access_l1\\"\\n}","type":"json"}]', 'title' => 'GetUserLogDeliveryQuota', 'description' => 'This operation allows you to query the remaining real-time log delivery quota of each log category in your Alibaba Cloud account. You must provide your Alibaba Cloud account ID (aliUid) and log category (BusinessType). The system then returns the remaining quota of the log category to help you track the usage.'."\n", 'changeSet' => [ - [ - 'createdAt' => '2024-09-27T05:57:02.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-27T05:57:02.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetUserLogDeliveryQuota', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUserLogDeliveryQuota'], ], ], 'ramActions' => [ @@ -51781,12 +29398,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -51798,14 +29410,9 @@ ], ], 'GetUserWafRuleset' => [ - 'summary' => 'Queries the details of a Web Application Firewall (WAF) ruleset for a specified instance.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the details of a WAF ruleset for a specified instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -51818,265 +29425,133 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239606', - 'abilityTreeNodes' => [ - 'FEATUREdcdnV3YEJ8', - 'FEATUREdcdnUTRW1O', - 'FEATUREdcdnSU2QP6', - 'FEATUREdcdnV3G3FZ', - 'FEATUREdcdnBQ0J3E', - ], + 'abilityTreeNodes' => ['FEATUREdcdnV3YEJ8', 'FEATUREdcdnUTRW1O', 'FEATUREdcdnSU2QP6', 'FEATUREdcdnV3G3FZ', 'FEATUREdcdnBQ0J3E'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'esa-xxxxxxx', - 'title' => '', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'esa-xxxxxxx', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The WAF ruleset ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10000001', - 'title' => '', - ], + 'schema' => ['title' => '', 'description' => 'The WAF ruleset ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000001'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], 'Ruleset' => [ + 'description' => 'The WAF ruleset.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The WAF ruleset ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000001', - 'title' => '', - ], - 'Position' => [ - 'description' => 'The position of the WAF ruleset.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The name of the WAF ruleset.', - 'type' => 'string', - 'example' => 'example', - 'title' => '', - ], - 'Description' => [ - 'description' => 'The description of the WAF ruleset.', - 'type' => 'string', - 'example' => 'example', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the WAF ruleset.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Expression' => [ - 'description' => 'The expression for the WAF ruleset.', - 'type' => 'string', - 'example' => 'ip.src == 1.1.1.1', - 'title' => '', - ], - 'Phase' => [ - 'description' => 'The WAF phase.', - 'type' => 'string', - 'example' => 'http_custom', - 'title' => '', - ], - 'Shared' => [ - 'description' => 'The shared configuration of the WAF ruleset.', - '$ref' => '#/components/schemas/WafBatchRuleShared', - 'example' => '{}', - 'title' => '', - ], + 'Id' => ['description' => 'The WAF ruleset ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000001', 'title' => ''], + 'Position' => ['description' => 'The position of the WAF ruleset.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Name' => ['description' => 'The name of the WAF ruleset.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'Description' => ['description' => 'The description of the WAF ruleset.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'Status' => ['description' => 'The status of the WAF ruleset.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Expression' => ['description' => 'The expression of the WAF ruleset.', 'type' => 'string', 'example' => 'ip.src == 1.1.1.1', 'title' => ''], + 'Phase' => ['description' => 'The phase in which the WAF rule runs. Valid values:'."\n" + .'- http_whitelist: whitelist rule'."\n" + .'- http_custom: custom rule'."\n" + .'- http_managed: managed rule'."\n" + .'- http_anti_scan: scan protection rule'."\n" + .'- http_ratelimit: frequency control rule', 'type' => 'string', 'example' => 'http_custom', 'title' => ''], + 'Shared' => ['description' => 'The shared configuration of the WAF ruleset.', '$ref' => '#/components/schemas/WafBatchRuleShared', 'example' => '{}', 'title' => ''], 'Rules' => [ + 'description' => 'The list of rule configurations in the WAF ruleset.', 'type' => 'array', 'items' => [ + 'description' => 'The rule configuration in the WAF ruleset.', 'type' => 'object', 'properties' => [ - 'UpdateTime' => [ - 'description' => 'The time when the WAF rule was last updated.', - 'type' => 'string', - 'example' => '2025-07-07T15:00:00Z', - 'title' => '', - ], - 'RulesetId' => [ - 'description' => 'The WAF ruleset ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000001', - 'title' => '', - ], - 'Id' => [ - 'description' => 'The WAF rule ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20000001', - 'title' => '', - ], - 'Position' => [ - 'description' => 'The position of the WAF rule.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'title' => '', - ], - 'Phase' => [ - 'description' => 'The WAF phase.', - 'type' => 'string', - 'example' => 'http_custom', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The type of the WAF rule.', - 'type' => 'string', - 'example' => '● 频次控制规则 - http_ratelimit'."\n" - .'● 高频扫描封禁 - http_high_frequency'."\n" - .'● 目录遍历封禁 - http_directory_traversal', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The name of the WAF rule.', - 'type' => 'string', - 'example' => 'example', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the WAF rule.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], + 'UpdateTime' => ['description' => 'The time when the WAF rule was last updated.'."\n" + ."\n" + .'Format: RFC 3339 / ISO 8601, UTC time zone (ending with Z).'."\n" + ."\n" + .'Example: 2025-07-07T15:00:00Z', 'type' => 'string', 'example' => '2025-07-07T15:00:00Z', 'title' => ''], + 'RulesetId' => ['description' => 'The WAF ruleset ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000001', 'title' => ''], + 'Id' => ['description' => 'The WAF rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '20000001', 'title' => ''], + 'Position' => ['description' => 'The position of the WAF rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Phase' => ['description' => 'The phase in which the WAF rule runs. Valid values:'."\n" + .'- http_whitelist: whitelist rule'."\n" + .'- http_custom: custom rule'."\n" + .'- http_managed: managed rule'."\n" + .'- http_anti_scan: scan protection rule'."\n" + .'- http_ratelimit: frequency control rule', 'type' => 'string', 'example' => 'http_custom', 'title' => ''], + 'Type' => ['description' => 'The type of the WAF rule.', 'type' => 'string', 'example' => 'http_ratelimit', 'title' => ''], + 'Name' => ['description' => 'The name of the WAF rule.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'Status' => ['description' => 'The status of the WAF rule.', 'type' => 'string', 'example' => 'on', 'title' => ''], 'Fields' => [ + 'description' => 'The list of match fields for the WAF rule.', 'type' => 'array', - 'items' => [ - 'description' => 'A match field for the WAF rule.', - 'type' => 'string', - 'example' => 'ip.src', - 'title' => '', - ], - 'description' => 'A list of match fields for the WAF rule.', + 'items' => ['description' => 'The match field of the WAF rule.', 'type' => 'string', 'example' => 'ip.src', 'title' => ''], 'example' => '["ip.src"]', 'title' => '', ], 'CharacteristicsFields' => [ + 'description' => 'The list of statistics fields for the WAF rule.', 'type' => 'array', - 'items' => [ - 'description' => 'A statistical field for the WAF rule.', - 'type' => 'string', - 'example' => 'http.host', - 'title' => '', - ], - 'description' => 'A list of statistical fields for the WAF rule.', + 'items' => ['description' => 'The statistics field of the WAF rule.', 'type' => 'string', 'example' => 'http.host', 'title' => ''], 'example' => '["http.host"]', 'title' => '', ], - 'Action' => [ - 'description' => 'The action of the WAF rule.', - 'type' => 'string', - 'example' => 'deny', - 'title' => '', - ], - 'Skip' => [ - 'description' => 'The method for skipping the WAF rule.', - 'type' => 'string', - 'example' => 'all', - 'title' => '', - ], + 'Action' => ['description' => 'The action of the rule. Valid values:'."\n" + .'- deny: Block.'."\n" + .'- monitor: Monitor.'."\n" + .'- js: JavaScript Challenge.'."\n" + .'- captcha: Slider challenge.', 'type' => 'string', 'example' => 'deny', 'title' => ''], + 'Skip' => ['description' => 'The skip mode of the WAF rule.', 'type' => 'string', 'example' => 'all', 'title' => ''], 'Tags' => [ + 'description' => 'The list of phases to skip for the WAF rule.', 'type' => 'array', - 'items' => [ - 'description' => 'A phase to skip for the WAF rule.', - 'type' => 'string', - 'example' => 'http_custom', - 'title' => '', - ], - 'description' => 'A list of phases to skip for the WAF rule.', + 'items' => ['description' => 'The phase to skip for the WAF rule.', 'type' => 'string', 'example' => 'http_custom', 'title' => ''], 'example' => '["http_custom"]', 'title' => '', ], - 'Config' => [ - 'description' => 'The configuration of the WAF rule.', - '$ref' => '#/components/schemas/WafRuleConfig', - 'example' => '{'."\n" - .' "Id": 20000001,'."\n" - .' "Name": "rule1",'."\n" - .' "Expression": "ip.src eq 1.1.1.1",'."\n" - .' "Action": "deny"'."\n" - .'}', - 'title' => '', - ], + 'Config' => ['description' => 'The configuration of the WAF rule.', '$ref' => '#/components/schemas/WafRuleConfig', 'example' => '{'."\n" + .' "Id": 20000001,'."\n" + .' "Name": "rule1",'."\n" + .' "Expression": "ip.src eq 1.1.1.1",'."\n" + .' "Action": "deny"'."\n" + .'}', 'title' => ''], ], - 'description' => 'The configuration of a rule in the WAF ruleset.', 'example' => '{}', 'title' => '', ], - 'description' => 'A list of rule configurations in the WAF ruleset.', 'example' => '[{}]', 'title' => '', ], ], - 'description' => 'The WAF ruleset.', 'example' => '{}', 'title' => '', ], ], - 'title' => '', - 'description' => 'The response schema.', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'GetUserWafRuleset', - 'description' => '##'."\n" - ."\n" - .'You can call the `GetUserWafRuleset` operation to retrieve information about a specific Web Application Firewall (WAF) ruleset. Provide the instance ID and ruleset ID. The operation returns details about the ruleset, such as its position, name, description, status, and the rules it contains. Provide all required parameters to prevent request failures.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get user WAF ruleset', + 'description' => '## Operation description'."\n" + .'By calling the `GetUserWafRuleset` operation, you can retrieve information about a specific Web Application Firewall (WAF) ruleset based on the instance ID and ruleset ID. The returned information includes but is not limited to the position, name, description, status, and specific rules of the ruleset. Make sure that you correctly specify the required parameters to avoid request failures.', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUserWafRuleset'], + ], ], 'ramActions' => [ [ @@ -52086,27 +29561,17 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - '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 1.1.1.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"}]', + '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 \\"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 1.1.1.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' => [ 'summary' => 'Queries the video processing configuration details of a site.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -52119,34 +29584,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257665', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '23282348***', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23282348***', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration ID. You can call the [ListVideoProcessings](~~ListVideoProcessings~~) operation to obtain the configuration ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '23321557***', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID. You can call the [ListVideoProcessings](~~ListVideoProcessings~~) operation to obtain the configuration ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23321557***', 'title' => ''], ], ], 'responses' => [ @@ -52156,105 +29605,32 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'."\n", - ], - 'ConfigId' => [ - 'description' => 'The configuration ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '35281609698****', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'The type of the configuration. Valid values:'."\n" - ."\n" - .'* global: global configuration.'."\n" - .'* rule: rule configuration.'."\n", - 'type' => 'string', - 'example' => 'global', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'The version number of the website configurations.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'The order in which the rule is executed. A smaller value gives priority to the rule.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Indicates whether the rule is enabled. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'The rule content.'."\n", - 'type' => 'string', - 'example' => '(http.host eq \\"video.example.com\\")'."\n", - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'The name of the scaling rule.'."\n", - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], - 'VideoSeekEnable' => [ - 'description' => 'Video seeking. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'FlvVideoSeekMode' => [ - 'description' => 'FLV Seeking Valid values:'."\n" - ."\n" - .'* by_byte: Seek by byte.'."\n" - .'* by_time: Seek by time.'."\n", - 'type' => 'string', - 'example' => 'by_byte', - 'title' => '', - ], - 'Mp4SeekStart' => [ - 'description' => 'Customize the mp4 start parameter.'."\n", - 'type' => 'string', - 'example' => 'start', - 'title' => '', - ], - 'Mp4SeekEnd' => [ - 'description' => 'Customize the mp4 end parameter.'."\n", - 'type' => 'string', - 'example' => 'end', - 'title' => '', - ], - 'FlvSeekStart' => [ - 'description' => 'The custom start parameter for FLV files.'."\n", - 'type' => 'string', - 'example' => 'start', - 'title' => '', - ], - 'FlvSeekEnd' => [ - 'description' => 'The custom end parameter for FLV files.'."\n", - 'type' => 'string', - 'example' => 'end', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'."\n"], + 'ConfigId' => ['description' => 'The configuration ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '35281609698****', 'title' => ''], + 'ConfigType' => ['description' => 'The type of the configuration. Valid values:'."\n" + ."\n" + .'* global: global configuration.'."\n" + .'* rule: rule configuration.'."\n", 'type' => 'string', 'example' => 'global', 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the website configurations.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Sequence' => ['description' => 'The order in which the rule is executed. A smaller value gives priority to the rule.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuleEnable' => ['description' => 'Indicates whether the rule is enabled. Valid values:'."\n" + ."\n" + .'* on'."\n" + .'* off'."\n", 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'The rule content.'."\n", 'type' => 'string', 'example' => '(http.host eq \\"video.example.com\\")'."\n", 'title' => ''], + 'RuleName' => ['description' => 'The name of the scaling rule.'."\n", 'type' => 'string', 'example' => 'rule_example', 'title' => ''], + 'VideoSeekEnable' => ['description' => 'Video seeking. Valid values:'."\n" + ."\n" + .'* on'."\n" + .'* off'."\n", 'type' => 'string', 'example' => 'on', 'title' => ''], + 'FlvVideoSeekMode' => ['description' => 'FLV Seeking Valid values:'."\n" + ."\n" + .'* by_byte: Seek by byte.'."\n" + .'* by_time: Seek by time.'."\n", 'type' => 'string', 'example' => 'by_byte', 'title' => ''], + 'Mp4SeekStart' => ['description' => 'Customize the mp4 start parameter.'."\n", 'type' => 'string', 'example' => 'start', 'title' => ''], + 'Mp4SeekEnd' => ['description' => 'Customize the mp4 end parameter.'."\n", 'type' => 'string', 'example' => 'end', 'title' => ''], + 'FlvSeekStart' => ['description' => 'The custom start parameter for FLV files.'."\n", 'type' => 'string', 'example' => 'start', 'title' => ''], + 'FlvSeekEnd' => ['description' => 'The custom end parameter for FLV files.'."\n", 'type' => 'string', 'example' => 'end', 'title' => ''], ], 'example' => '', ], @@ -52262,11 +29638,7 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], '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"}]', @@ -52283,26 +29655,15 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], ], 'GetWafBotAppKey' => [ - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -52315,9 +29676,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239630', - 'abilityTreeNodes' => [ - 'FEATUREdcdn1OLUH8', - ], + 'abilityTreeNodes' => ['FEATUREdcdn1OLUH8'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [], @@ -52326,18 +29685,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], - 'AppKey' => [ - 'title' => 'APP key', - 'description' => 'Application key.', - 'type' => 'string', - 'example' => 'example_appkey', - ], + 'RequestId' => ['title' => '请求ID', 'description' => 'Request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], + 'AppKey' => ['title' => 'APP key', 'description' => 'Application key.', 'type' => 'string', 'example' => 'example_appkey'], ], 'description' => '', 'title' => '', @@ -52347,39 +29696,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"AppKey\\": \\"example_appkey\\"\\n}","type":"json"}]', 'title' => 'Get the APP key in the BOT phase of WAF', 'summary' => 'This interface is used to obtain the application key (AppKey) for the BOT behavior detection feature in the site\'s Web Application Firewall (WAF). The key is typically used for authentication and data exchange with the WAF service.', 'changeSet' => [ - [ - 'createdAt' => '2024-09-25T07:02:51.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T06:56:38.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-25T07:02:51.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T06:56:38.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetWafBotAppKey', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWafBotAppKey'], ], ], 'ramActions' => [ @@ -52390,25 +29720,15 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'GetWafFilter' => [ - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -52421,174 +29741,78 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239605', - 'abilityTreeNodes' => [ - 'FEATUREdcdnUTRW1O', - 'FEATUREdcdnSU2QP6', - 'FEATUREdcdnV3G3FZ', - 'FEATUREdcdnBQ0J3E', - 'FEATUREdcdn1OLUH8', - ], + 'abilityTreeNodes' => ['FEATUREdcdnUTRW1O', 'FEATUREdcdnSU2QP6', 'FEATUREdcdnV3G3FZ', 'FEATUREdcdnBQ0J3E', 'FEATUREdcdn1OLUH8'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Specifies the ID of the site. You can get this ID by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false], ], [ 'name' => 'Phase', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The WAF rule category to which the filter conditions to query belong.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http_bot', - ], + 'schema' => ['description' => 'Specifies the WAF phase from which to retrieve the matching engine information.', 'type' => 'string', 'example' => 'http_bot', 'title' => '', 'required' => false], ], [ 'name' => 'Target', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The condition for matching incoming requests.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'characteristics', - ], + 'schema' => ['description' => 'Specifies the application target of the matching engine.', 'type' => 'string', 'example' => 'characteristics', 'title' => '', 'required' => false], ], [ 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The rule type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http_custom_cc', - ], + 'schema' => ['description' => 'Specifies the rule type.', 'type' => 'string', 'example' => 'http_custom_cc', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The schema of the response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], 'Filter' => [ 'title' => '', - 'description' => 'The returned match conditions.'."\n", + 'description' => 'The returned matching engine configuration.', 'type' => 'object', 'properties' => [ - 'Phase' => [ - 'title' => '', - 'description' => 'The WAF rule category.'."\n", - 'type' => 'string', - 'example' => 'http_bot', - ], - 'Target' => [ - 'title' => '', - 'description' => 'The condition for matching incoming requests.'."\n", - 'type' => 'string', - 'example' => 'characteristics', - ], - 'Type' => [ - 'title' => '', - 'description' => 'The rule type.'."\n", - 'type' => 'string', - 'example' => 'http_custom_cc', - ], + 'Phase' => ['description' => 'The phase at which the WAF processes requests.', 'type' => 'string', 'example' => 'http_bot', 'title' => ''], + 'Target' => ['description' => 'The target of the matching engine.', 'type' => 'string', 'example' => 'characteristics', 'title' => ''], + 'Type' => ['description' => 'The rule type.', 'type' => 'string', 'example' => 'http_custom_cc', 'title' => ''], 'Fields' => [ 'title' => '', - 'description' => 'The matched objects and related properties.'."\n", + 'description' => 'A list of match objects and their properties.', 'type' => 'array', 'items' => [ 'title' => '', - 'description' => 'The properties of the matched object.'."\n", + 'description' => 'A match object.', 'type' => 'object', 'properties' => [ - 'Enable' => [ - 'description' => 'Indicates whether the current plan supports this matching object.', - 'type' => 'boolean', - 'example' => 'false', - 'title' => '', - ], - 'MinPlan' => [ - 'description' => 'If the current plan does not support this matching item, display the minimum plan that supports it. ', - 'type' => 'string', - 'example' => 'high', - 'title' => '', - ], - 'Label' => [ - 'title' => '', - 'description' => 'The label of the matched object.'."\n", - 'type' => 'string', - 'example' => 'Header', - ], - 'Key' => [ - 'title' => '', - 'description' => 'The field for matched objects in the system.'."\n", - 'type' => 'string', - 'example' => 'http.request.headers', - ], - 'Sub' => [ - 'title' => '', - 'description' => 'Indicates whether the matched object contains a subfield.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'SubTip' => [ - 'title' => '', - 'description' => 'The tip on how to enter a subfield.'."\n", - 'type' => 'string', - 'example' => 'e.g. Content-Type', - ], + 'Enable' => ['description' => 'Indicates whether the current plan supports this match object.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'MinPlan' => ['description' => 'The minimum plan that supports this match object, provided the current plan does not.', 'type' => 'string', 'example' => 'high', 'title' => ''], + 'Label' => ['description' => 'The label for the match object.', 'type' => 'string', 'example' => 'Header', 'title' => ''], + 'Key' => ['description' => 'The internal key for the match object.', 'type' => 'string', 'example' => 'http.request.headers', 'title' => ''], + 'Sub' => ['description' => 'Indicates whether the match object includes subfields.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'SubTip' => ['description' => 'A hint for entering the subfield value.', 'type' => 'string', 'example' => 'e.g. Content-Type', 'title' => ''], 'Selector' => [ 'title' => '', - 'description' => 'The selector, which defines how to select a matched object.'."\n", + 'description' => 'The selector, which defines how to select the match object.', 'type' => 'object', 'properties' => [ - 'Kind' => [ - 'title' => '', - 'description' => 'The type of selector. Valid values: data and others.'."\n", - 'type' => 'string', - 'example' => 'data', - ], + 'Kind' => ['description' => 'The selector type, which indicates whether it targets data items or other entities.', 'type' => 'string', 'example' => 'data', 'title' => ''], 'Data' => [ 'title' => '', - 'description' => 'The data. This parameter is available only when the value of the Kind parameter is data.'."\n", + 'description' => 'A list of data options available when the selector `Kind` is `data`.', 'type' => 'array', 'items' => [ 'title' => '', - 'description' => 'The data. This parameter is available only when the value of the Kind parameter is data.'."\n", + 'description' => 'A data option available when the selector `Kind` is `data`.', 'type' => 'object', 'properties' => [ - 'Label' => [ - 'title' => '', - 'description' => 'The label of the data.'."\n", - 'type' => 'string', - 'example' => 'China', - ], - 'Value' => [ - 'title' => '', - 'description' => 'The value of the data.'."\n", - 'type' => 'string', - 'example' => 'CN', - ], + 'Label' => ['description' => 'The label for the data option.', 'type' => 'string', 'example' => 'China', 'title' => ''], + 'Value' => ['description' => 'The value of the data option.', 'type' => 'string', 'example' => 'CN', 'title' => ''], ], 'example' => '', ], @@ -52599,107 +29823,47 @@ ], 'Logics' => [ 'title' => '', - 'description' => 'The logical conditions.'."\n", + 'description' => 'A list of logical operators that define the matching conditions.', 'type' => 'array', 'items' => [ 'title' => '', - 'description' => 'The properties of the logical operator applicable to the matched object.'."\n", + 'description' => 'A logical operator that applies to the match object.', 'type' => 'object', 'properties' => [ - 'Enable' => [ - 'description' => 'Indicates whether the current plan supports this matching symbol.', - 'type' => 'boolean', - 'example' => 'false', - 'title' => '', - ], - 'MinPlan' => [ - 'description' => 'If the current plan does not support this operator, display the minimum plan that supports it. ', - 'type' => 'string', - 'example' => 'high', - 'title' => '', - ], - 'Symbol' => [ - 'title' => '', - 'description' => 'The matching characters in the system.'."\n", - 'type' => 'string', - 'example' => 'eq', - ], - 'Operator' => [ - 'title' => '', - 'description' => 'The displayed matching characters.'."\n", - 'type' => 'string', - 'example' => 'Does not equal', - ], - 'Negative' => [ - 'title' => '', - 'description' => 'Indicates whether the match result is inverted.'."\n", - 'type' => 'boolean', - 'example' => '', - ], - 'Type' => [ - 'title' => '', - 'description' => 'The type of the value. Valid values:'."\n" - ."\n" - .'* integer'."\n" - .'* integer_slice'."\n" - .'* string'."\n" - .'* string_slice'."\n", - 'type' => 'string', - 'example' => 'string', - ], - 'Kind' => [ - 'title' => '', - 'description' => 'The type of the value input box. Valid values:'."\n" - ."\n" - .'* select:single'."\n" - .'* select:multi'."\n" - .'* input:single'."\n" - .'* input:multi'."\n", - 'type' => 'string', - 'example' => 'input:single', - ], - 'Attributes' => [ - 'title' => '', - 'description' => 'A custom attribute. For example, this parameter can specify whether the value is case-sensitive.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Tip' => [ - 'title' => '', - 'description' => 'The tip on how to enter a valid value that is required by the rules.'."\n", - 'type' => 'string', - 'example' => 'e.g. image/jpeg', - ], + 'Enable' => ['description' => 'Indicates whether the current plan supports this operator.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'MinPlan' => ['description' => 'The minimum plan that supports this operator, provided the current plan does not.', 'type' => 'string', 'example' => 'high', 'title' => ''], + 'Symbol' => ['description' => 'The internal identifier for the operator.', 'type' => 'string', 'example' => 'eq', 'title' => ''], + 'Operator' => ['description' => 'The label for the operator.', 'type' => 'string', 'example' => 'Does not equal', 'title' => ''], + 'Negative' => ['description' => 'Indicates whether to negate the match result.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'Type' => ['description' => 'The type of the value. Valid values:'."\n" + ."\n" + .'- `integer`: An integer.'."\n" + ."\n" + .'- `integer_slice`: An integer array.'."\n" + ."\n" + .'- `string`: A string.'."\n" + ."\n" + .'- `string_slice`: A string array.', 'type' => 'string', 'example' => 'string', 'title' => ''], + 'Kind' => ['description' => 'The input type for the value. Valid values:'."\n" + ."\n" + .'- `select:single`: A single-select input.'."\n" + ."\n" + .'- `select:multi`: A multi-select input.'."\n" + ."\n" + .'- `input:single`: A single-value text input.'."\n" + ."\n" + .'- `input:multi`: A multi-value text input.', 'type' => 'string', 'example' => 'input:single', 'title' => ''], + 'Attributes' => ['description' => 'Configurable attributes, such as case sensitivity.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Tip' => ['description' => 'A hint for entering a valid value.', 'type' => 'string', 'example' => 'e.g. image/jpeg', 'title' => ''], 'Validator' => [ 'title' => '', - 'description' => 'The validator, which defines the validation rules for a value.'."\n", + 'description' => 'The validator, which defines validation rules for the value.', 'type' => 'object', 'properties' => [ - 'Length' => [ - 'title' => '', - 'description' => 'The length of the value.'."\n", - '$ref' => '#/components/schemas/WafQuotaInteger', - 'example' => '', - ], - 'Pattern' => [ - 'title' => '', - 'description' => 'The regular expression pattern of the value, which is used to validate strings.'."\n", - 'type' => 'string', - 'example' => '^example$', - ], - 'Range' => [ - 'title' => '', - 'description' => 'The range of the value, which is used to validate numbers.'."\n", - '$ref' => '#/components/schemas/WafQuotaInteger', - 'example' => '', - ], - 'ErrMsg' => [ - 'title' => '', - 'description' => 'The error message when the validation fails.'."\n", - 'type' => 'string', - 'example' => 'Enter a valid expression', - ], + 'Length' => ['description' => 'The length limit for the value.', '$ref' => '#/components/schemas/WafQuotaInteger', 'title' => '', 'example' => ''], + 'Pattern' => ['description' => 'The regular expression pattern for the value.', 'type' => 'string', 'example' => '^example$', 'title' => ''], + 'Range' => ['description' => 'The value range for numeric validation.', '$ref' => '#/components/schemas/WafQuotaInteger', 'title' => '', 'example' => ''], + 'ErrMsg' => ['description' => 'The error message returned when validation fails.', 'type' => 'string', 'example' => 'Enter a valid expression', 'title' => ''], ], 'example' => '', ], @@ -52723,45 +29887,21 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Obtain WAF matching engine information ', - 'summary' => 'Obtain the matching engine information for a specified site at a specific WAF phase. This information defines how the WAF detects and processes different types of network requests. ', + 'summary' => 'Retrieves matching engine information for a site at a given WAF phase, which defines how the WAF detects and handles various network requests.', 'changeSet' => [ - [ - 'createdAt' => '2025-02-27T08:44:24.000Z', - 'description' => 'Response parameters changed', - ], - [ - 'createdAt' => '2024-09-25T07:02:51.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T06:56:36.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-02-27T08:44:24.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-09-25T07:02:51.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T06:56:36.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetWafFilter', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWafFilter'], ], ], 'ramActions' => [ @@ -52772,12 +29912,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -52785,14 +29920,9 @@ '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\\": false,\\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' => 'Get WAF Quota Details', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Retrieves quota details for Web Application Firewall (WAF) resources. These quotas define the quantity limits of corresponding resources that a customer can use, such as managed rule groups, custom lists, custom response pages, and scenario-specific protection rules.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -52805,115 +29935,62 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239612', - 'abilityTreeNodes' => [ - 'FEATUREdcdnL8HX1L', - ], + 'abilityTreeNodes' => ['FEATUREdcdnL8HX1L'], ], 'parameters' => [ [ 'name' => 'Paths', 'in' => 'query', - 'schema' => [ - 'title' => 'WAF配额的路径，例：managed_rules_group、list、page、scene_policy', - 'description' => 'The path of the WAF quota, for example:'."\n" - .'* managed_rules_group: represents the quota for the WAF managed rules group'."\n" - .'* list: represents the quota for custom lists'."\n" - .'* page: represents the quota for custom response pages'."\n" - .'* scene_policy: represents the quota for scenario protection', - 'type' => 'string', - 'required' => false, - 'example' => 'page', - ], + 'schema' => ['title' => '', 'description' => 'The paths of WAF quotas. Valid values:'."\n" + .'* managed_rules_group: the quota for WAF managed rule groups.'."\n" + .'* list: the quota for custom lists.'."\n" + .'* page: the quota for custom response pages.'."\n" + .'* scene_policy: the quota for scenario-specific protection rules.', 'type' => 'string', 'example' => 'page', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], 'Quota' => [ - 'title' => 'WAF配额', - 'description' => 'Returned quota information.', + 'title' => '', + 'description' => 'The returned quota information.', 'type' => 'object', 'properties' => [ 'ManagedRulesGroup' => [ - 'title' => '托管规则组相关配额', - 'description' => 'Quota information related to the WAF managed rules group.', + 'title' => '', + 'description' => 'The quota information for WAF managed rule groups.', 'type' => 'object', 'properties' => [ - 'Enable' => [ - 'title' => '托管规则组开关', - 'description' => 'Indicates whether the WAF managed rules group is enabled.', - 'type' => 'boolean', - 'example' => '', - ], - 'NumberTotal' => [ - 'title' => '托管规则组数量配额', - 'description' => 'The total number quota allowed for the WAF managed rules group.', - '$ref' => '#/components/schemas/WafQuotaInteger', - 'example' => '', - ], + 'Enable' => ['title' => '', 'description' => 'Indicates whether WAF managed rule groups are enabled.', 'type' => 'boolean', 'example' => ''], + 'NumberTotal' => ['title' => '', 'description' => 'The total quantity quota for WAF managed rule groups.', '$ref' => '#/components/schemas/WafQuotaInteger', 'example' => ''], ], 'example' => '', ], 'List' => [ - 'title' => '自定义列表相关配额', - 'description' => 'Quota information related to custom lists.', + 'title' => '', + 'description' => 'The quota information for custom lists.', 'type' => 'object', 'properties' => [ - 'Enable' => [ - 'title' => '自定义列表开关', - 'description' => 'Indicates whether the custom list is enabled.', - 'type' => 'boolean', - 'example' => '', - ], - 'NumberTotal' => [ - 'title' => '自定义列表数量配额', - 'description' => 'The total number quota allowed for custom lists.', - '$ref' => '#/components/schemas/WafQuotaInteger', - 'example' => '', - ], - 'NumberItemsTotal' => [ - 'title' => '自定义列表中全部项目数量配额', - 'description' => 'The total number quota allowed for items in all custom lists.', - '$ref' => '#/components/schemas/WafQuotaInteger', - 'example' => '', - ], - 'NumberItemsPerList' => [ - 'title' => '每个自定义列表中项目数量配额', - 'description' => 'The number quota allowed per custom list.', - '$ref' => '#/components/schemas/WafQuotaInteger', - 'example' => '', - ], + 'Enable' => ['title' => '', 'description' => 'Indicates whether custom lists are enabled.', 'type' => 'boolean', 'example' => ''], + 'NumberTotal' => ['title' => '', 'description' => 'The total quantity quota for custom lists.', '$ref' => '#/components/schemas/WafQuotaInteger', 'example' => ''], + 'NumberItemsTotal' => ['title' => '', 'description' => 'The total quantity quota for items across all custom lists.', '$ref' => '#/components/schemas/WafQuotaInteger', 'example' => ''], + 'NumberItemsPerList' => ['title' => '', 'description' => 'The quantity quota for items in each custom list.', '$ref' => '#/components/schemas/WafQuotaInteger', 'example' => ''], 'Items' => [ - 'title' => '自定义列表中项目类型相关配额', - 'description' => 'An object containing quota information for each type of item in the custom list.', + 'title' => '', + 'description' => 'The object that contains quota information for each item type in custom lists.', 'type' => 'object', 'additionalProperties' => [ - 'title' => '自定义列表中项目配额结构', - 'description' => 'An object containing quota information for items in the custom list.', + 'title' => '', + 'description' => 'The object that contains quota information for items in custom lists.', 'type' => 'object', 'properties' => [ - 'Enable' => [ - 'title' => '对应自定义列表项目类型的开关', - 'description' => 'The switch for the type of item in the custom list.', - 'type' => 'boolean', - 'example' => '', - ], - 'Value' => [ - 'title' => '对应自定义列表中项目类型的格式限制', - 'description' => 'Format restrictions for the type of item in the custom list.', - '$ref' => '#/components/schemas/WafQuotaString', - 'example' => '', - ], + 'Enable' => ['title' => '', 'description' => 'Indicates whether the corresponding custom list item type is enabled.', 'type' => 'boolean', 'example' => ''], + 'Value' => ['title' => '', 'description' => 'The format restriction for the corresponding item type in custom lists.', '$ref' => '#/components/schemas/WafQuotaString', 'example' => ''], ], 'example' => '', ], @@ -52923,43 +30000,23 @@ 'example' => '', ], 'Page' => [ - 'title' => '自定义响应页面相关配额', - 'description' => 'Quota information related to custom response pages.', + 'title' => '', + 'description' => 'The quota information for custom response pages.', 'type' => 'object', 'properties' => [ - 'Enable' => [ - 'title' => '自定义响应页面开关', - 'description' => 'Indicates whether the custom response page is enabled.', - 'type' => 'boolean', - 'example' => '', - ], - 'NumberTotal' => [ - 'title' => '自定义响应页面数量配额', - 'description' => 'The total number quota allowed for custom response pages.', - '$ref' => '#/components/schemas/WafQuotaInteger', - 'example' => '', - ], + 'Enable' => ['title' => '', 'description' => 'Indicates whether custom response pages are enabled.', 'type' => 'boolean', 'example' => ''], + 'NumberTotal' => ['title' => '', 'description' => 'The total quantity quota for custom response pages.', '$ref' => '#/components/schemas/WafQuotaInteger', 'example' => ''], 'ContentTypes' => [ - 'title' => '自定义响应页面Content-Type相关配额', - 'description' => 'An object containing quota information for each Content-Type in custom response pages.', + 'title' => '', + 'description' => 'The object that contains quota information for each Content-Type in custom response pages.', 'type' => 'object', 'additionalProperties' => [ - 'title' => '自定义响应页面中ContentType对应类型配额结构', - 'description' => 'An object of quota information for the Content-Type in custom response pages.', + 'title' => '', + 'description' => 'The object that contains Content-Type quota information for custom response pages.', 'type' => 'object', 'properties' => [ - 'Enable' => [ - 'title' => '对应自定义响应页面Content-Type类型开关', - 'description' => 'The switch for the Content-Type type in custom response pages.', - 'type' => 'boolean', - 'example' => '', - ], - 'ContentLength' => [ - 'title' => '对应自定义响应页面Content-Type的内容长度配额', - 'description' => 'The content length quota for the Content-Type in custom response pages.', - '$ref' => '#/components/schemas/WafQuotaInteger', - 'example' => '', - ], + 'Enable' => ['title' => '', 'description' => 'Indicates whether the corresponding Content-Type for custom response pages is enabled.', 'type' => 'boolean', 'example' => ''], + 'ContentLength' => ['title' => '', 'description' => 'The content length quota for the corresponding Content-Type in custom response pages.', '$ref' => '#/components/schemas/WafQuotaInteger', 'example' => ''], ], 'example' => '', ], @@ -52969,45 +30026,35 @@ 'example' => '', ], 'ScenePolicy' => [ - 'title' => '场景防护相关配额', - 'description' => 'Quota information related to scene protection.', + 'title' => '', + 'description' => 'The quota information for scenario-specific protection rules.', 'type' => 'object', 'properties' => [ - 'Enable' => [ - 'title' => '场景防护开关', - 'description' => 'Indicates whether the scene protection feature is enabled.', - 'type' => 'boolean', - 'example' => '', - ], - 'NumberTotal' => [ - 'title' => '场景防护规则数量配额', - 'description' => 'The total number quota for scene protection rules.', - '$ref' => '#/components/schemas/WafQuotaInteger', - 'example' => '', - ], + 'Enable' => ['title' => '', 'description' => 'Indicates whether the scenario-specific protection feature is enabled.', 'type' => 'boolean', 'example' => ''], + 'NumberTotal' => ['title' => '', 'description' => 'The total quantity quota for scenario-specific protection rules.', '$ref' => '#/components/schemas/WafQuotaInteger', 'example' => ''], ], 'example' => '', ], 'Captcha' => [ - 'description' => 'Quota information related to verification code rules. ', + 'description' => 'The quota information for CAPTCHA rules.', 'type' => 'object', 'properties' => [ - 'Enable' => [ - 'description' => 'Indicates whether the verification code rule is enabled. ', - 'type' => 'boolean', - 'title' => '', - 'example' => '', - ], - 'NumberTotal' => [ - 'description' => 'The total quota for the number of allowed verification code rules. ', - '$ref' => '#/components/schemas/WafQuotaInteger', - 'title' => '', - 'example' => '', - ], + 'Enable' => ['description' => 'Indicates whether CAPTCHA rules are enabled.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'NumberTotal' => ['description' => 'The total quantity quota for CAPTCHA rules.', '$ref' => '#/components/schemas/WafQuotaInteger', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], + 'SliderCaptchaPage' => [ + 'title' => '', + 'description' => 'The quota information for slider CAPTCHA pages.', + 'type' => 'object', + 'properties' => [ + 'Enable' => ['title' => '', 'description' => 'Indicates whether slider CAPTCHA pages are enabled.', 'type' => 'boolean', 'example' => ''], + 'NumberTotal' => ['title' => '', 'description' => 'The quantity quota for slider CAPTCHA pages.', '$ref' => '#/components/schemas/WafQuotaInteger', 'example' => ''], + ], + 'example' => '', + ], ], 'example' => '', ], @@ -53018,44 +30065,24 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'title' => 'Get WAF Resource Related Quotas', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Quota\\": {\\n \\"ManagedRulesGroup\\": {\\n \\"Enable\\": false,\\n \\"NumberTotal\\": {\\n \\"Equal\\": 1,\\n \\"GreaterThan\\": 1,\\n \\"GreaterThanOrEqual\\": 1,\\n \\"LessThan\\": 1,\\n \\"LessThanOrEqual\\": 1\\n }\\n },\\n \\"List\\": {\\n \\"Enable\\": false,\\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\\": false,\\n \\"Value\\": {\\n \\"Regexp\\": \\"^\\\\\\\\d+$\\"\\n }\\n }\\n }\\n },\\n \\"Page\\": {\\n \\"Enable\\": false,\\n \\"ContentTypes\\": {\\n \\"key\\": {\\n \\"Enable\\": false\\n }\\n }\\n },\\n \\"ScenePolicy\\": {\\n \\"Enable\\": false\\n },\\n \\"Captcha\\": {\\n \\"Enable\\": false\\n },\\n \\"SliderCaptchaPage\\": {\\n \\"Enable\\": false\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve WAF resource quotas', 'changeSet' => [ - [ - 'createdAt' => '2024-09-25T07:02:51.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T06:56:36.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-25T07:02:51.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T06:56:36.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetWafQuota', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWafQuota'], ], ], 'ramActions' => [ @@ -53066,27 +30093,16 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Quota\\": {\\n \\"ManagedRulesGroup\\": {\\n \\"Enable\\": false,\\n \\"NumberTotal\\": {\\n \\"Equal\\": 1,\\n \\"GreaterThan\\": 1,\\n \\"GreaterThanOrEqual\\": 1,\\n \\"LessThan\\": 1,\\n \\"LessThanOrEqual\\": 1\\n }\\n },\\n \\"List\\": {\\n \\"Enable\\": false,\\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\\": false,\\n \\"Value\\": {\\n \\"Regexp\\": \\"^\\\\\\\\d+$\\"\\n }\\n }\\n }\\n },\\n \\"Page\\": {\\n \\"Enable\\": false,\\n \\"ContentTypes\\": {\\n \\"key\\": {\\n \\"Enable\\": false\\n }\\n }\\n },\\n \\"ScenePolicy\\": {\\n \\"Enable\\": false\\n },\\n \\"Captcha\\": {\\n \\"Enable\\": false\\n }\\n }\\n}","type":"json"}]', ], 'GetWafRule' => [ - 'summary' => 'Get Details of a Single WAF Rule', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Retrieves the details of a single rule in Web Application Firewall (WAF). You can use this operation to query the configuration and status of a specific rule.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -53099,113 +30115,48 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239626', - 'abilityTreeNodes' => [ - 'FEATUREdcdnV3YEJ8', - 'FEATUREdcdnUTRW1O', - 'FEATUREdcdnSU2QP6', - 'FEATUREdcdnV3G3FZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdnV3YEJ8', 'FEATUREdcdnUTRW1O', 'FEATUREdcdnSU2QP6', 'FEATUREdcdnV3G3FZ'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '规则ID', - 'description' => 'The ID of the WAF rule, which can be obtained by calling the [ListWafRules](~~2878257~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20000001', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the WAF rule. You can call the [ListWafRules](~~2878257~~) operation to obtain the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20000001'], ], [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'title' => '站点ID', - 'description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], - 'UpdateTime' => [ - 'title' => '修改时间', - 'description' => 'The last modified time of the rule.', - 'type' => 'string', - 'example' => '2024-01-01T00:00:00Z', - ], - 'Id' => [ - 'title' => '规则ID', - 'description' => 'The ID of the WAF rule, which can be obtained by calling the [ListWafRules](~~2878257~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2000001', - 'pattern' => '', - 'default' => '', - ], - 'Position' => [ - 'title' => '规则在规则集中所处的位置顺序', - 'description' => 'The position of the rule in the rule set.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Name' => [ - 'title' => '规则名称', - 'description' => 'Rule name.', - 'type' => 'string', - 'required' => true, - 'example' => 'example', - 'maxLength' => 128, - 'pattern' => '', - 'default' => '', - ], - 'Status' => [ - 'title' => '规则状态', - 'description' => 'Rule status.', - 'type' => 'string', - 'example' => 'on', - ], - 'Phase' => [ - 'title' => 'WAF阶段', - 'description' => 'WAF operation phase.', - 'type' => 'string', - 'required' => true, - 'example' => 'http_custom', - 'pattern' => '', - 'default' => '', - ], - 'Config' => [ - 'title' => '规则配置', - 'description' => 'Rule configuration.', - '$ref' => '#/components/schemas/WafRuleConfig', - 'example' => '', - ], - 'RulesetId' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], + 'UpdateTime' => ['title' => '', 'description' => 'The time when the rule was last modified.'."\n" + ."\n" + .'Format: RFC 3339 / ISO 8601, UTC time zone (ending with Z).'."\n" + ."\n" + .'Example: 2026-06-10T14:23:45Z', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], + 'Id' => ['title' => '', 'description' => 'The ID of the WAF rule. You can call the [ListWafRules](~~2878257~~) operation to obtain the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2000001', 'pattern' => '', 'default' => ''], + 'Position' => ['title' => '', 'description' => 'The position of the rule in the ruleset.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Name' => ['title' => '', 'description' => 'The rule name.', 'type' => 'string', 'required' => true, 'example' => 'example', 'maxLength' => 128, 'pattern' => '', 'default' => ''], + 'Status' => ['title' => '', 'description' => 'The rule status.', 'type' => 'string', 'example' => 'on'], + 'Phase' => ['title' => '', 'description' => 'The phase in which the WAF rule runs. Valid values:'."\n" + .'- http_whitelist: whitelist rule'."\n" + .'- http_custom: custom rule'."\n" + .'- http_managed: managed rule'."\n" + .'- http_anti_scan: scan protection rule'."\n" + .'- http_ratelimit: frequency control rule'."\n" + .'- ip_access_rule: IP access rule'."\n" + .'- http_bot: advanced mode bots'."\n" + .'- http_security_level_rule: security rule', 'type' => 'string', 'required' => true, 'example' => 'http_custom', 'pattern' => '', 'default' => ''], + 'Config' => ['title' => '', 'description' => 'The rule configuration.', '$ref' => '#/components/schemas/WafRuleConfig', 'example' => ''], + 'RulesetId' => ['description' => 'The ID of the WAF ruleset. You can call the [ListWafRulesets](~~2878359~~) operation to obtain the ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000001', 'title' => ''], ], 'example' => '', ], @@ -53213,40 +30164,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'Get Details of a Single WAF Rule', + 'staticInfo' => ['returnType' => 'synchronous'], + '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 1.1.1.1\\",\\n \\"SecurityLevel\\": {\\n \\"Value\\": \\"low\\"\\n },\\n \\"Value\\": \\"10.0.0.1\\",\\n \\"Id\\": 20000001,\\n \\"Notes\\": \\"example notes\\"\\n },\\n \\"RulesetId\\": 10000001\\n}","type":"json"}]', + 'title' => 'Get details of a single WAF rule', 'changeSet' => [ - [ - 'createdAt' => '2025-04-17T07:08:14.000Z', - 'description' => 'Response parameters changed', - ], - [ - 'createdAt' => '2024-09-25T07:02:50.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-04-17T07:08:14.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-09-25T07:02:50.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetWafRule', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWafRule'], ], ], 'ramActions' => [ @@ -53257,27 +30188,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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 1.1.1.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' => [ - 'summary' => 'Get WAF Ruleset Details', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Retrieves the details of a specified WAF ruleset. You can call this operation to query the configuration and status information of a specific ruleset.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -53290,118 +30210,64 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239606', - 'abilityTreeNodes' => [ - 'FEATUREdcdnBQ0J3E', - 'FEATUREdcdn1OLUH8', - ], + 'abilityTreeNodes' => ['FEATUREdcdnBQ0J3E', 'FEATUREdcdn1OLUH8'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '规则集ID', - 'description' => 'The ID of the WAF ruleset, which can be obtained by calling the ListWafRulesets interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10000001', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the WAF ruleset. You can call the [ListWafRulesets](~~2878359~~) operation to obtain the ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000001', 'required' => false], ], [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'title' => '站点ID', - 'description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'Phase', 'in' => 'query', - 'schema' => [ - 'title' => 'WAF阶段', - 'description' => 'The WAF operation phase, specifying the phase of the ruleset to query.', - 'type' => 'string', - 'required' => false, - 'example' => 'http_bot', - ], + 'schema' => ['title' => '', 'description' => 'The WAF rule execution phase. Valid values:'."\n" + .'- http_whitelist: whitelist rules'."\n" + .'- http_custom: custom rules'."\n" + .'- http_managed: managed rules'."\n" + .'- http_anti_scan: scan protection rules'."\n" + .'- http_ratelimit: rate limiting rules'."\n" + .'- ip_access_rule: IP access rules'."\n" + .'- http_bot: advanced mode bots'."\n" + .'- http_security_level_rule: security rules', 'type' => 'string', 'example' => 'http_bot', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], - 'UpdateTime' => [ - 'title' => '修改时间', - 'description' => 'The last modified time of the ruleset.', - 'type' => 'string', - 'example' => '2024-01-01T00:00:00Z', - ], - 'Id' => [ - 'title' => '规则集ID', - 'description' => 'Ruleset ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10000001', - 'pattern' => '', - 'default' => '', - ], - 'Name' => [ - 'title' => '规则集名称', - 'description' => 'Ruleset name.', - 'type' => 'string', - 'required' => true, - 'example' => 'example', - 'maxLength' => 128, - 'pattern' => '', - 'default' => '', - ], - 'Status' => [ - 'title' => '规则集状态', - 'description' => 'Ruleset status.', - 'type' => 'string', - 'example' => 'on', - ], - 'Phase' => [ - 'title' => 'WAF阶段', - 'description' => 'The WAF operation phase applicable to the ruleset.', - 'type' => 'string', - 'required' => true, - 'example' => 'http_bot', - 'pattern' => '', - 'default' => '', - ], - 'Shared' => [ - 'title' => '规则集中的规则所共享的配置', - 'description' => 'Shared configurations for the rules in the ruleset.', - '$ref' => '#/components/schemas/WafBatchRuleShared', - 'example' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], + 'UpdateTime' => ['title' => '', 'description' => 'The last modification time of the ruleset.'."\n" + ."\n" + .'Format: RFC 3339 / ISO 8601, UTC time zone (ending with Z).'."\n" + ."\n" + .'Example: 2026-06-10T14:23:45Z', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], + 'Id' => ['title' => '', 'description' => 'The ID of the WAF ruleset. You can call the [ListWafRulesets](~~2878359~~) operation to obtain the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000001', 'pattern' => '', 'default' => ''], + 'Name' => ['title' => '', 'description' => 'The ruleset name.', 'type' => 'string', 'required' => true, 'example' => 'example', 'maxLength' => 128, 'pattern' => '', 'default' => ''], + 'Status' => ['title' => '', 'description' => 'The ruleset status.', 'type' => 'string', 'example' => 'on'], + 'Phase' => ['title' => '', 'description' => 'The WAF rule execution phase. Valid values:'."\n" + .'- http_whitelist: whitelist rules'."\n" + .'- http_custom: custom rules'."\n" + .'- http_managed: managed rules'."\n" + .'- http_anti_scan: scan protection rules'."\n" + .'- http_ratelimit: rate limiting rules'."\n" + .'- ip_access_rule: IP access rules'."\n" + .'- http_bot: advanced mode bots'."\n" + .'- http_security_level_rule: security rules', 'type' => 'string', 'required' => true, 'example' => 'http_bot', 'pattern' => '', 'default' => ''], + 'Shared' => ['title' => '', 'description' => 'The shared configuration of rules in the ruleset.', '$ref' => '#/components/schemas/WafBatchRuleShared', 'example' => ''], 'Rules' => [ - 'title' => '规则集中的规则配置列表', - 'description' => 'List of rule configurations in the ruleset.', + 'title' => '', + 'description' => 'The list of rule configurations in the ruleset.', 'type' => 'array', - 'items' => [ - 'title' => '规则集中的规则配置', - 'description' => 'Rule configuration within the rule set.', - '$ref' => '#/components/schemas/WafRuleConfig', - 'example' => '', - ], + 'items' => ['title' => '', 'description' => 'The rule configuration in the ruleset.', '$ref' => '#/components/schemas/WafRuleConfig', 'example' => ''], 'example' => '', ], ], @@ -53411,40 +30277,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'Get Details of a Single WAF Ruleset', + 'staticInfo' => ['returnType' => 'synchronous'], + '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 1.1.1.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"}]', + 'title' => 'Get WAF ruleset details', 'changeSet' => [ - [ - 'createdAt' => '2024-09-25T07:02:50.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T06:56:35.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-25T07:02:50.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T06:56:35.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'GetWafRuleset', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWafRuleset'], ], ], 'ramActions' => [ @@ -53455,26 +30301,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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 1.1.1.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' => 'Query Cache Reserve Instance List', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the cache reserve instances for your account.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -53487,9 +30323,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238745', - 'abilityTreeNodes' => [ - 'FEATUREdcdn51XOHW', - ], + 'abilityTreeNodes' => ['FEATUREdcdn51XOHW'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ @@ -53500,20 +30334,17 @@ 'schema' => [ 'description' => 'The status of the cache reserve instance. Valid values:'."\n" ."\n" - .'* **online**: The instance is in service.'."\n" - .'* **offline**: The instance has expired within an allowable period. In this state, it is unavailable.'."\n" - .'* **disable**: The instance has been released.'."\n" - .'* **overdue**: The instance has been stopped due to overdue payments.'."\n", + .'- **online**: The instance is running normally.'."\n" + ."\n" + .'- **offline**: The instance has expired and is unavailable but remains within the grace period.'."\n" + ."\n" + .'- **disable**: The instance is disabled.'."\n" + ."\n" + .'- **overdue**: The instance is suspended due to an overdue payment.', 'type' => 'string', + 'enum' => ['online', 'offline', 'disable', 'all', 'overdue'], 'required' => false, 'example' => 'online', - 'enum' => [ - 'online', - 'offline', - 'disable', - 'all', - 'overdue', - ], 'title' => '', ], ], @@ -53522,18 +30353,15 @@ 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ - 'description' => 'The criterion by which you want to sort the queried instances. Valid values:'."\n" + 'description' => 'The field to sort the results by. Valid values:'."\n" ."\n" - .'* **ExpireTime**'."\n" - .'* **CreateTime**'."\n", + .'- **ExpireTime**: Expiration time.'."\n" + ."\n" + .'- **CreateTime**: Creation time.', 'type' => 'string', + 'enum' => ['ExpireTime', 'CreateTime', 'default'], 'required' => false, 'example' => 'ExpireTime', - 'enum' => [ - 'ExpireTime', - 'CreateTime', - 'default', - ], 'title' => '', ], ], @@ -53541,131 +30369,65 @@ 'name' => 'SortOrder', 'in' => 'query', 'schema' => [ - 'title' => '', - 'description' => 'The order by which you want to sort the queried instances. Valid values:'."\n" + 'description' => 'The sort order. Valid values:'."\n" + ."\n" + .'- **asc**: Ascending order.'."\n" ."\n" - .'* **asc**'."\n" - .'* **desc**'."\n", + .'- **desc**: Descending order.', 'type' => 'string', + 'enum' => ['asc', 'desc'], + 'title' => '', 'required' => false, 'example' => 'desc', - 'enum' => [ - 'asc', - 'desc', - ], ], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'Page number.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Page size. Range: **1~500**, default is **500**.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values: **1 to 500**. The default value is **500**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'sp-xcdn-96wblslz****', - 'title' => '', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'sp-xcdn-96wblslz****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Details of the cache reserve instances.'."\n", + 'description' => 'The query results.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '65C66B7B-671A-8297-9187-2R5477247B76', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '65C66B7B-671A-8297-9187-2R5477247B76'], 'InstanceInfo' => [ - 'description' => 'The cache reserve instances.'."\n", + 'description' => 'A list of cache reserve instances.', 'type' => 'array', 'items' => [ - 'description' => 'Details of the cache reserve instance.'."\n", + 'description' => 'The details of a cache reserve instance.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'example' => 'sp-xcdn-96wblslz****', - 'title' => '', - ], - 'ExpireTime' => [ - 'description' => 'Instance expiration time.', - 'type' => 'string', - 'example' => '2024-10-05T16:00:00Z', - 'title' => '', - ], - 'Duration' => [ - 'description' => 'Duration of the instance purchase, unit: months.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'Instance purchase time.', - 'type' => 'string', - 'example' => '2024-04-12T05:41:51Z', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the cache reserve instance. Valid values:'."\n" - ."\n" - .'* **online**: The instance is in service.'."\n" - .'* **offline**: The instance has expired within an allowable period. In this state, it is unavailable.'."\n" - .'* **disable**: The instance has been released.'."\n" - .'* **overdue**: The instance has been stopped due to overdue payments.'."\n", - 'type' => 'string', - 'example' => 'online', - 'title' => '', - ], - 'CacheReserveRegion' => [ - 'description' => 'Cache reserve usage region.', - 'type' => 'string', - 'example' => 'HK', - 'title' => '', - ], - 'CacheReserveCapacity' => [ - 'description' => 'Cache reserve capacity. Unit: GB.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '512000', - 'title' => '', - ], - 'ChargeType' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'sp-xcdn-96wblslz****', 'title' => ''], + 'ExpireTime' => ['description' => 'The expiration time of the instance.', 'type' => 'string', 'example' => '2024-10-05T16:00:00Z', 'title' => ''], + 'Duration' => ['description' => 'The purchase duration of the instance, in months.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2024-04-12T05:41:51Z', 'title' => ''], + 'Status' => ['description' => 'The status of the instance. Valid values:'."\n" + ."\n" + .'- **online**: The instance is running normally.'."\n" + ."\n" + .'- **offline**: The instance has expired and is unavailable but remains within the grace period.'."\n" + ."\n" + .'- **disable**: The instance is disabled.'."\n" + ."\n" + .'- **overdue**: The instance is suspended due to an overdue payment.', 'type' => 'string', 'example' => 'online', 'title' => ''], + 'CacheReserveRegion' => ['description' => 'The region where the cache reserve instance is used.', 'type' => 'string', 'example' => 'HK', 'title' => ''], + 'CacheReserveCapacity' => ['description' => 'The cache reserve capacity, in GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '512000', 'title' => ''], + 'ChargeType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', @@ -53673,34 +30435,10 @@ 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'description' => 'Page number. Default value: **1**.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'Page size, default **500**, range: **1~500**.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'Total count.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - 'title' => '', - ], - 'TotalPage' => [ - 'description' => 'Total pages.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], + 'PageNumber' => ['description' => 'The page number of the returned data.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'example' => '', ], @@ -53708,29 +30446,16 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], ], ], - '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"}]', 'title' => 'ListCacheReserveInstances', 'changeSet' => [ - [ - 'createdAt' => '2025-02-21T03:25:57.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-02-21T03:25:57.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListCacheReserveInstances', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCacheReserveInstances'], ], ], 'ramActions' => [ @@ -53741,25 +30466,17 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', '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' => 'Query multiple cache configurations', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries multiple cache configurations.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -53772,337 +30489,155 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257498', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '35281609698****', 'title' => ''], ], [ 'name' => 'ConfigType', 'in' => 'query', 'schema' => [ - 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', - 'description' => 'Configuration type, which can be used to query global or rule-based configurations. Possible values:'."\n" - .'- global: Query global configuration.'."\n" - .'- rule: Query rule-based configuration.'."\n" + 'title' => '', + 'description' => 'The configuration type. You can use this parameter to query global or rule configurations. Valid values:'."\n" + .'- global: queries global configurations.'."\n" + .'- rule: queries rule configurations.'."\n" ."\n" - .'This parameter is optional; if not provided, it will not distinguish between global and rule-based configurations.', + .'This parameter is optional. If you do not specify this parameter, both global and rule configurations are returned.', + 'enumValueTitles' => ['rule' => 'rule configuration.', 'global' => 'global configuration.'], 'type' => 'string', + 'enum' => ['global', 'rule'], 'required' => false, 'example' => 'global', - 'enum' => [ - 'global', - 'rule', - ], ], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['title' => '', 'description' => 'The rule name. You do not need to set this parameter when you add a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '第几页，不传时默认为1', - 'description' => 'Page number, defaulting to 1 if not provided.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number for a paged query. The value must be greater than or equal to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '每页几条，最大500，不传时默认500', - 'description' => 'Number of items per page, with a maximum of 500. Defaults to 500 if not provided.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page for a paged query. Valid values: 1 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Site version number. For sites with version management enabled, this parameter can specify the site version for which the configuration takes effect, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], 'Configs' => [ - 'description' => 'Response body configuration.', + 'description' => 'The configuration list in the response body.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '395386449776640', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'Site configuration version number. For sites with version management enabled, this parameter can specify the site version for which the configuration takes effect, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'Rule execution order. The smaller the value, the higher the priority.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Possible values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, e.g., (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'example' => '(http.host eq \\"video.example.com\\")', - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'Configuration type, which can be used to query global or rule-based configurations. Possible values:'."\n" - .'- global: Query global configuration.'."\n" - .'- rule: Query rule-based configuration.', - 'type' => 'string', - 'example' => 'global', - 'title' => '', - ], - 'BypassCache' => [ - 'description' => 'Set bypass cache mode. Possible values:'."\n" - .'- cache_all: Cache all requests.'."\n" - .'- bypass_all: Bypass cache for all requests.', - 'type' => 'string', - 'example' => 'cache_all', - 'title' => '', - ], - 'BrowserCacheMode' => [ - 'description' => 'Browser cache mode. Possible values:'."\n" - .'- no_cache: Do not cache.'."\n" - .'- follow_origin: Follow origin cache policy.'."\n" - .'- override_origin: Override origin cache policy.', - 'type' => 'string', - 'example' => 'no_cache', - 'title' => '', - ], - 'BrowserCacheTtl' => [ - 'description' => 'Browser cache expiration time, in seconds.', - 'type' => 'string', - 'example' => '300', - 'title' => '', - ], - 'EdgeCacheMode' => [ - 'description' => 'Edge cache mode. The value range is as follows:'."\n" - .'- follow_origin: Follow the origin server\'s cache policy (if it exists), otherwise use the default cache policy.'."\n" - .'- no_cache: Do not cache.'."\n" - .'- override_origin: Override the origin server\'s cache policy.'."\n" - .'- follow_origin_bypass: Follow the origin server\'s cache policy (if it exists), otherwise do not cache.', - 'type' => 'string', - 'example' => 'follow_origin', - 'title' => '', - ], - 'EdgeCacheTtl' => [ - 'description' => 'Edge cache expiration time, in seconds.', - 'type' => 'string', - 'example' => '300', - 'title' => '', - ], - 'EdgeStatusCodeCacheTtl' => [ - 'description' => 'Edge cache expiration time, in seconds.', - 'type' => 'string', - 'example' => '4xx=10', - 'title' => '', - ], - 'SortQueryStringForCache' => [ - 'description' => 'Query string sorting. The value range is as follows:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'QueryStringMode' => [ - 'description' => 'The processing mode for query strings when generating the cache key. The value range is as follows:'."\n" - .'- ignore_all: Ignore all query strings.'."\n" - .'- exclude_query_string: Exclude specified query strings.'."\n" - .'- reserve_all: Default, reserve all query strings.'."\n" - .'- include_query_string: Include specified query strings.', - 'type' => 'string', - 'example' => 'ignore_all', - 'title' => '', - ], - 'QueryString' => [ - 'description' => 'The query strings to be reserved or excluded. Multiple values are supported, separated by spaces.', - 'type' => 'string', - 'example' => 'example', - 'title' => '', - ], - 'IncludeHeader' => [ - 'description' => 'Include the specified header names and their values when generating the cache key. Multiple values are supported, separated by spaces.', - 'type' => 'string', - 'example' => 'example', - 'title' => '', - ], - 'IncludeCookie' => [ - 'description' => 'Include the specified cookie names and their values when generating the cache key. Multiple values are supported, separated by spaces.', - 'type' => 'string', - 'example' => 'cookie_exapmle', - 'title' => '', - ], - 'CacheReserveEligibility' => [ - 'description' => 'Cache reserve eligibility. This is used to control whether user requests bypass the cache reserve node when returning to the origin. The value range is as follows:'."\n" - .'- bypass_cache_reserve: Requests bypass the cache reserve.'."\n" - .'- eligible_for_cache_reserve: Eligible for cache reserve.', - 'type' => 'string', - 'example' => 'bypass_cache_reserve', - 'title' => '', - ], - 'CheckPresenceHeader' => [ - 'description' => 'When generating the cache key, check if the header exists. If it does, add the header name (case-insensitive) to the cache key. Multiple header names are supported, separated by spaces.', - 'type' => 'string', - 'example' => 'headername', - 'title' => '', - ], - 'CheckPresenceCookie' => [ - 'description' => 'When generating the cache key, check if the cookie exists. If it does, add the cookie name (case-insensitive) to the cache key. Multiple cookie names are supported, separated by spaces.', - 'type' => 'string', - 'example' => 'cookiename', - 'title' => '', - ], - 'UserDeviceType' => [ - 'description' => 'Include the client device type when generating the cache key. The value range is as follows:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'UserGeo' => [ - 'description' => 'Include the client\'s geographic location when generating the cache key. The value range is as follows:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'UserLanguage' => [ - 'description' => 'Include the client\'s language type when generating the cache key. The value range is as follows:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'ServeStale' => [ - 'description' => 'Serve stale cache. When enabled, the node can still respond to user requests with expired cached files even when the origin server is unavailable. Value range:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'AdditionalCacheablePorts' => [ - 'description' => 'Enable caching on specified ports. Value range: 8880, 2052, 2082, 2086, 2095, 2053, 2083, 2087, 2096.', - 'type' => 'string', - 'example' => '2082', - 'title' => '', - ], - 'CacheDeceptionArmor' => [ - 'description' => 'Cache deception defense. Used to defend against web cache deception attacks; only verified cache content will be cached. Value range:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'PostCache' => [ - 'description' => 'Toggle for the Post caching feature. ', - 'title' => 'Toggle for the Post caching feature. ', - 'type' => 'string', - 'example' => 'on', - ], - 'PostBodyCacheKey' => [ - 'description' => 'Processing pattern for the cache key. ', - 'title' => 'Processing pattern for the cache key. ', - 'type' => 'string', - 'example' => 'ignore', - ], - 'PostBodySizeLimit' => [ - 'description' => 'Body size limit. The value is a numeric value in KB. Body sizes from 1 KB to 8 KB are supported. When the value is empty, it defaults to 8 KB.', - 'type' => 'string', - 'example' => '1', - 'title' => '', - ], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '395386449776640', 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Sequence' => ['description' => 'The rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuleEnable' => ['description' => 'The rule switch. You do not need to set this parameter when you add a global configuration. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'The rule content, which uses conditional expressions to match user requests. You do not need to set this parameter when you add a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: set the value to true.'."\n" + .'- Match specified requests: set the value to a custom expression, such as (http.host eq \\"video.example.com\\").', 'type' => 'string', 'example' => '(http.host eq \\"video.example.com\\")', 'title' => ''], + 'RuleName' => ['description' => 'The rule name. You do not need to set this parameter when you add a global configuration.', 'type' => 'string', 'example' => 'rule_example', 'title' => ''], + 'ConfigType' => ['description' => 'The configuration type. You can use this parameter to query global or rule configurations. Valid values:'."\n" + ."\n" + .'- global: global configuration.'."\n" + .'- rule: rule configuration.', 'type' => 'string', 'example' => 'global', 'title' => ''], + 'BypassCache' => ['description' => 'The bypass cache mode. Valid values:'."\n" + .'- cache_all: caches all requests.'."\n" + .'- bypass_all: bypasses cache for all requests.', 'type' => 'string', 'example' => 'cache_all', 'title' => ''], + 'BrowserCacheMode' => ['description' => 'The browser cache mode. Valid values:'."\n" + .'- no_cache: does not cache.'."\n" + .'- follow_origin: follows the origin cache policy.'."\n" + .'- override_origin: overrides the origin cache policy.', 'type' => 'string', 'example' => 'no_cache', 'title' => ''], + 'BrowserCacheTtl' => ['description' => 'The browser cache expiration time, in seconds.', 'type' => 'string', 'example' => '300', 'title' => ''], + 'EdgeCacheMode' => ['description' => 'The edge cache mode. Valid values:'."\n" + .'- follow_origin: follows the origin cache policy if present. Otherwise, uses the default cache policy.'."\n" + .'- no_cache: does not cache.'."\n" + .'- override_origin: overrides the origin cache policy.'."\n" + .'- follow_origin_bypass: follows the origin cache policy if present. Otherwise, does not cache.'."\n" + .'- follow_origin_override: follows the origin cache policy if present. Otherwise, uses a custom cache TTL.', 'type' => 'string', 'example' => 'follow_origin', 'title' => ''], + 'EdgeCacheTtl' => ['description' => 'The edge cache expiration time, in seconds.', 'type' => 'string', 'example' => '300', 'title' => ''], + 'EdgeStatusCodeCacheTtl' => ['description' => 'The status code cache expiration time, in seconds.'."\n" + .'- You can set the cache expiration time for specific status codes. For example, 404=10 indicates that the 404 status code is cached for 10 seconds.'."\n" + .'- You can set the cache expiration time for 4xx or 5xx series status codes. For example, 4xx=10 indicates that all 4xx status codes are cached for 10 seconds.'."\n" + .'- You can set the cache expiration time for multiple status codes. Separate multiple status codes with commas (,).', 'type' => 'string', 'example' => '5xx=0,404=10', 'title' => ''], + 'SortQueryStringForCache' => ['description' => 'Specifies whether to sort query strings. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'QueryStringMode' => ['description' => 'The query string handling mode when generating cache keys. Valid values:'."\n" + .'- ignore_all: ignores all query strings.'."\n" + .'- exclude_query_string: removes specified query strings.'."\n" + .'- reserve_all: retains all query strings. This is the default value.'."\n" + .'- include_query_string: retains specified query strings.', 'type' => 'string', 'example' => 'ignore_all', 'title' => ''], + 'QueryString' => ['description' => 'The query strings to retain or remove when generating cache keys. Multiple values are separated by spaces.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'IncludeHeader' => ['description' => 'The specified header names (case-insensitive) and their values to include when generating cache keys. Multiple values are separated by spaces. Header names support the following character types:'."\n" + .'- Symbols: ! # $ % & \' * + - . ^ _ ` | ~'."\n" + .'- Digits: 0-9'."\n" + .'- Letters: lowercase a-z.', 'type' => 'string', 'example' => 'headername1 headername2', 'title' => ''], + 'IncludeCookie' => ['description' => 'The specified cookie names (case-insensitive) and their values to include when generating cache keys. Multiple values are separated by spaces. Cookie names support the following character types:'."\n" + .'- Symbols: ! # $ % & \' * + - . ^ _ ` | ~'."\n" + .'- Digits: 0-9'."\n" + .'- Letters: lowercase a-z.', 'type' => 'string', 'example' => 'cookiename1 cookiename2', 'title' => ''], + 'CacheReserveEligibility' => ['description' => 'The cache reserve eligibility. Controls whether user requests bypass the cache reserve node during back-to-origin. Valid values:'."\n" + .'- bypass_cache_reserve: requests bypass cache reserve.'."\n" + .'- eligible_for_cache_reserve: requests are eligible for cache reserve.', 'type' => 'string', 'example' => 'bypass_cache_reserve', 'title' => ''], + 'CheckPresenceHeader' => ['description' => 'When generating cache keys, checks whether the specified headers exist. If a header exists, its name (case-insensitive) is added to the cache key. Multiple header names are separated by spaces. Header names support the following character types:'."\n" + .'- Symbols: ! # $ % & \' * + - . ^ _ ` | ~'."\n" + .'- Digits: 0-9'."\n" + .'- Letters: lowercase a-z.', 'type' => 'string', 'example' => 'headername1 headername2', 'title' => ''], + 'CheckPresenceCookie' => ['description' => 'When generating cache keys, checks whether the specified cookies exist. If a cookie exists, its name (case-insensitive) is added to the cache key. Multiple cookie names are separated by spaces. Cookie names support the following character types:'."\n" + .'- Symbols: ! # $ % & \' * + - . ^ _ ` | ~'."\n" + .'- Digits: 0-9'."\n" + .'- Letters: lowercase a-z.', 'type' => 'string', 'example' => 'cookiename1 cookiename2', 'title' => ''], + 'UserDeviceType' => ['description' => 'Specifies whether to include the type of the client when generating cache keys. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: shutdown.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'UserGeo' => ['description' => 'Specifies whether to include the client geographic location when generating cache keys. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'UserLanguage' => ['description' => 'Specifies whether to include the client language type when generating cache keys. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'ServeStale' => ['description' => 'Specifies whether to serve stale cache. When enabled, edge nodes can respond to user requests with cached expired files when the origin server is unavailable. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'AdditionalCacheablePorts' => ['description' => '- Enables caching on specified ports.'."\n" + .'- Valid values: 8880, 2052, 2082, 2086, 2095, 2053, 2083, 2087, and 2096.'."\n" + .'- Multiple ports are separated by commas (,).', 'type' => 'string', 'example' => '8880,2052,2086', 'title' => ''], + 'CacheDeceptionArmor' => ['description' => 'The cache deception armor. Protects against web cache deception attacks by caching only content that passes validation. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'PostCache' => ['title' => '', 'description' => 'Specifies whether to enable POST caching.', 'type' => 'string', 'example' => 'on'], + 'PostBodyCacheKey' => ['title' => '', 'description' => 'The cache key handling mode for POST caching. The following two modes are supported:'."\n" + .'- md5: calculates the MD5 hash of the body content and adds the MD5 value to the cache key.'."\n" + .'- ignore: ignores the body content in the cache key.', 'type' => 'string', 'example' => 'ignore'], + 'PostBodySizeLimit' => ['description' => 'The body size limit for POST caching. The value is a number in KB. Valid values: 1 to 8. If this parameter is left empty, the default value of 8 KB takes effect.', 'type' => 'string', 'example' => '1', 'title' => ''], ], 'description' => '', 'title' => '', @@ -54111,34 +30646,10 @@ 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'description' => 'Current page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'Page size.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'Total number of records.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], - 'TotalPage' => [ - 'description' => 'Total number of pages.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - 'title' => '', - ], + 'PageNumber' => ['description' => 'The current page number, which is the same as the PageNumber request parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], 'example' => '', ], @@ -54146,32 +30657,17 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], ], ], - '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' => 'List Site Cache Configurations', + '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\\": \\"5xx=0,404=10\\",\\n \\"SortQueryStringForCache\\": \\"on\\",\\n \\"QueryStringMode\\": \\"ignore_all\\",\\n \\"QueryString\\": \\"example\\",\\n \\"IncludeHeader\\": \\"headername1 headername2\\",\\n \\"IncludeCookie\\": \\"cookiename1 cookiename2\\",\\n \\"CacheReserveEligibility\\": \\"bypass_cache_reserve\\",\\n \\"CheckPresenceHeader\\": \\"headername1 headername2\\",\\n \\"CheckPresenceCookie\\": \\"cookiename1 cookiename2\\",\\n \\"UserDeviceType\\": \\"on\\",\\n \\"UserGeo\\": \\"on\\",\\n \\"UserLanguage\\": \\"on\\",\\n \\"ServeStale\\": \\"on\\",\\n \\"AdditionalCacheablePorts\\": \\"8880,2052,2086\\",\\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' => 'Query site cache configuration list', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListCacheRules', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCacheRules'], ], ], 'ramActions' => [ @@ -54182,26 +30678,113 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], ], - 'ListCertificates' => [ - 'summary' => 'List certificates under a site', - 'methods' => [ - 'get', - 'post', + 'ListCasCertificates' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239382', + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The current page number. Default value: **1**.', 'type' => 'integer', 'format' => 'int64', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page size. Valid values: any integer from 1 to 1000.', 'type' => 'integer', 'format' => 'int64', 'default' => '1000', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'SearchKeyword', + 'in' => 'query', + 'schema' => ['description' => 'The certificate name for fuzzy match.', 'type' => 'string', 'required' => false, 'example' => 'aliyun', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Certificates' => [ + 'description' => 'The certificate list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The certificate.', + 'type' => 'object', + 'properties' => [ + 'NotAfter' => ['description' => 'The expiration time of the certificate.', 'type' => 'string', 'example' => '1708423200000', 'title' => ''], + 'Fingerprint' => ['description' => 'The certificate fingerprint.', 'type' => 'string', 'example' => '0151xxxx'."\n", 'title' => ''], + 'Name' => ['description' => 'The certificate name.', 'type' => 'string', 'example' => 'demo', 'title' => ''], + 'Issuer' => ['description' => 'The certificate issuer.', 'type' => 'string', 'example' => 'DigiCert', 'title' => ''], + 'Id' => ['description' => 'The certificate ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '30000145', 'title' => ''], + 'CommonName' => ['description' => 'The common name of the certificate.', 'type' => 'string', 'example' => 'example.com'."\n", 'title' => ''], + 'Region' => ['description' => 'The region where the certificate resides. Supported values: **cn-hangzhou** and **ap-southeast-1**.', 'type' => 'string', 'example' => 'ap-southeast-1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'PageNumber' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], ], - 'schemes' => [ - 'https', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'CertList.NotFound', 'errorMessage' => 'The specified CertList does not exist.', 'description' => 'The queried certificate list does not exist.'], + ], + ], + 'title' => 'Query China shield certificate list', + 'summary' => 'Queries the list of China Shield certificates.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'esa:ListCasCertificates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F61CDR30-E83C-4FDA-BF73-9A94CDD44229\\",\\n \\"TotalCount\\": 20,\\n \\"Certificates\\": [\\n {\\n \\"NotAfter\\": \\"1708423200000\\",\\n \\"Fingerprint\\": \\"0151xxxx\\\\n\\",\\n \\"Name\\": \\"demo\\",\\n \\"Issuer\\": \\"DigiCert\\",\\n \\"Id\\": 30000145,\\n \\"CommonName\\": \\"example.com\\\\n\\",\\n \\"Region\\": \\"ap-southeast-1\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', + ], + 'ListCertificates' => [ + 'summary' => 'Queries the certificate list for a specific site.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -54214,298 +30797,114 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238842', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to query the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword that is used for the search.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'example', - 'title' => '', - ], + 'schema' => ['description' => 'The search keyword.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], ], [ 'name' => 'ValidOnly', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to return only valid certificates.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to return only valid certificates.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3', - 'title' => '', - ], + 'schema' => ['description' => 'The page number of the data to return.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - 'title' => '', - ], + 'schema' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - 'title' => '', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567890123', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com ', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the data to return.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com ', 'title' => ''], 'Result' => [ - 'description' => 'The queried certificates.'."\n", + 'description' => 'The result array.', 'type' => 'array', 'items' => [ - 'description' => 'Details of the certificates.'."\n", + 'description' => 'The result.', 'type' => 'object', 'properties' => [ - 'CasId' => [ - 'description' => 'The certificate ID on Certificate Management Service.'."\n", - 'type' => 'string', - 'example' => '30000569', - 'title' => '', - ], - 'Id' => [ - 'description' => 'The certificate ID on ESA.'."\n", - 'type' => 'string', - 'example' => 'baba39055622c008b90285a8838e****', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The certificate name.'."\n", - 'type' => 'string', - 'example' => 'yourCertName', - 'title' => '', - ], - 'Region' => [ - 'description' => 'The region where the certificate is stored.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - 'title' => '', - ], + 'CasId' => ['description' => 'The cloud certificate ID.', 'type' => 'string', 'example' => '30000569', 'title' => ''], + 'Id' => ['description' => 'The certificate ID.', 'type' => 'string', 'example' => 'baba39055622c008b90285a8838e****', 'title' => ''], + 'Name' => ['description' => 'The certificate name.', 'type' => 'string', 'example' => 'yourCertName', 'title' => ''], + 'Region' => ['description' => 'The region information.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'Status' => [ - 'description' => 'The certificate status.'."\n" - ."\n" - .'* OK'."\n" - .'* Expired'."\n" - .'* Expiring'."\n" - .'* Issued'."\n" - .'* Applying'."\n" - .'* ApplyFailed'."\n" - .'* Canceled'."\n", + 'description' => 'The certificate status. Valid values:'."\n" + .'- OK: Normal.'."\n" + .'- Expired: The certificate has expired.'."\n" + .'- Expiring: The certificate is about to expire (within 30 days).'."\n" + .'- Issued: Free certificate - issued.'."\n" + .'- Applying: Free certificate - applying.'."\n" + .'- ApplyFailed: Free certificate - application failed.'."\n" + .'- Canceled: Free certificate - canceled.', + 'enumValueTitles' => ['Expiring' => 'The certificate is about to expire (within 30 days).', 'Issued' => 'Free certificate - issued.', 'Expired' => 'The certificate has expired.', 'Applying' => 'Free certificate - applying.', 'OK' => 'Normal.'], 'type' => 'string', 'example' => 'OK', - 'enumValueTitles' => [ - 'Expiring' => '证书即将过期（30 天内）', - 'Issued' => '免费证书-已签发', - 'Expired' => '证书已过期', - 'Applying' => '免费证书-申请中', - 'OK' => '正常', - ], 'title' => '', ], 'Type' => [ - 'description' => 'The certificate type.'."\n" - ."\n" - .'* cas: certificate that is purchased by using Certificate Management Service'."\n" - .'* upload: custom certificate that you upload'."\n" - .'* free: free certificate'."\n", + 'description' => 'The certificate type. Valid values:'."\n" + .'- cas: SSL Certificates Service certificate.'."\n" + .'- upload: Custom uploaded certificate.'."\n" + .'- free: Free certificate.'."\n" + .'- keyless: Keyless certificate.', + 'enumValueTitles' => ['cas' => 'SSL Certificates Service certificate.', 'upload' => 'Custom uploaded certificate.', 'keyless' => 'Keyless certificate.', 'free' => 'Free certificate.'], 'type' => 'string', 'example' => 'free', - 'enumValueTitles' => [ - 'cas' => '云盾证书', - 'upload' => '自定义上传证书', - 'keyless' => 'Keyless证书', - 'free' => '免费证书', - ], - 'title' => '', - ], - 'CommonName' => [ - 'description' => 'The Common Name of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com', - 'title' => '', - ], - 'NotBefore' => [ - 'description' => 'The time when the certificate takes effect.'."\n", - 'type' => 'string', - 'example' => '2023-03-31 02:08:00', - 'title' => '', - ], - 'NotAfter' => [ - 'description' => 'The time when the certificate expires.'."\n", - 'type' => 'string', - 'example' => '2024-03-31 02:08:00', - 'title' => '', - ], - 'Issuer' => [ - 'description' => 'The certificate authority (CA) that issued the certificate.'."\n", - 'type' => 'string', - 'example' => 'GlobalSign nv-sa', - 'title' => '', - ], - 'IssuerCN' => [ - 'description' => 'The Common Name of the certificate issuer.'."\n", - 'type' => 'string', - 'example' => 'GlobalSign Organization Validation CA - SHA256 - G3', - 'title' => '', - ], - 'SAN' => [ - 'description' => 'The Subject Alternative Name (SAN) of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com,*.example.com', - 'title' => '', - ], - 'SigAlg' => [ - 'description' => 'The signature algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'SHA256-RSA', - 'title' => '', - ], - 'PubAlg' => [ - 'description' => 'The public key algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'RSA', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the certificate was created.'."\n", - 'type' => 'string', - 'example' => '2022-06-24 07:48:51', - 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'The time when the certificate was updated.'."\n", - 'type' => 'string', - 'example' => '2023-04-20 06:18:42', - 'title' => '', - ], - 'SerialNumber' => [ - 'description' => 'The serial number of the certificate.'."\n", - 'type' => 'string', - 'example' => 'babab022c5e9b27bf9c64d7f4b16****', - 'title' => '', - ], - 'FingerprintSha256' => [ - 'description' => 'The SHA-256 fingerprint of the certificate.'."\n", - 'type' => 'string', - 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', 'title' => '', ], + 'CommonName' => ['description' => 'The common name of the certificate.', 'type' => 'string', 'example' => 'www.example.com', 'title' => ''], + 'NotBefore' => ['description' => 'The start time of the certificate validity period. Format: YYYY-MM-DD HH:MM:SS, in UTC/GMT time zone.', 'type' => 'string', 'example' => '2023-03-31 02:08:00', 'title' => ''], + 'NotAfter' => ['description' => 'The end time of the certificate validity period. Format: YYYY-MM-DD HH:MM:SS, in UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-03-31 02:08:00', 'title' => ''], + 'Issuer' => ['description' => 'The certificate issuer.', 'type' => 'string', 'example' => 'GlobalSign nv-sa', 'title' => ''], + 'IssuerCN' => ['description' => 'The common name of the certificate issuer.', 'type' => 'string', 'example' => 'GlobalSign Organization Validation CA - SHA256 - G3', 'title' => ''], + 'SAN' => ['description' => 'The Subject Alternative Name (SAN) of the certificate.', 'type' => 'string', 'example' => 'www.example.com,*.example.com', 'title' => ''], + 'SigAlg' => ['description' => 'The signature algorithm of the certificate.', 'type' => 'string', 'example' => 'SHA256-RSA', 'title' => ''], + 'PubAlg' => ['description' => 'The public key algorithm of the certificate.', 'type' => 'string', 'example' => 'RSA', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time. Format: YYYY-MM-DD HH:MM:SS, in UTC/GMT time zone.', 'type' => 'string', 'example' => '2022-06-24 07:48:51', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time. Format: YYYY-MM-DD HH:MM:SS, in UTC/GMT time zone.', 'type' => 'string', 'example' => '2023-04-20 06:18:42', 'title' => ''], + 'SerialNumber' => ['description' => 'The certificate serial number.', 'type' => 'string', 'example' => 'babab022c5e9b27bf9c64d7f4b16****', 'title' => ''], + 'FingerprintSha256' => ['description' => 'The SHA-256 fingerprint of the certificate.', 'type' => 'string', 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', 'title' => ''], 'DCV' => [ - 'description' => 'The Domain Control Validation (DCV) information.'."\n", + 'description' => 'The Domain Control Validation (DCV) information.', 'type' => 'array', 'items' => [ - 'description' => 'The DCV information.'."\n", + 'description' => 'The Domain Control Validation (DCV) information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The DCV ID.'."\n", - 'type' => 'string', - 'example' => 'bababf7cdd1546a2ad04c0def1f4****', - 'title' => '', - ], + 'Id' => ['description' => 'DCV ID。', 'type' => 'string', 'example' => 'bababf7cdd1546a2ad04c0def1f4****', 'title' => ''], 'Type' => [ - 'description' => 'The DCV type. Valid values: DNS and HTTP.'."\n", + 'description' => 'The DCV type. Valid values: DNS and HTTP.', + 'enumValueTitles' => ['DNS' => 'DNS', 'HTTP' => 'HTTP'], 'type' => 'string', - 'enumValueTitles' => [ - 'DNS' => 'DNS', - 'HTTP' => 'HTTP', - ], 'example' => 'HTTP', 'title' => '', ], - 'Key' => [ - 'description' => 'The DCV name. It is a TXT record name if Type is DNS or URL if Type is HTTP.'."\n", - 'type' => 'string', - 'example' => 'http://www.example.com/.well-known/acme-challenge/pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow', - 'title' => '', - ], - 'Value' => [ - 'description' => 'The DCV content.'."\n", - 'type' => 'string', - 'example' => 'pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow.KfzYo4LH3EgOt7a73G-RqZkbR0eYtLfEUmtmqGmr4FQ', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The verification status.'."\n", - 'type' => 'string', - 'example' => 'pending', - 'title' => '', - ], + 'Key' => ['description' => 'The DCV name. For the DNS type, this is the TXT record name. For the HTTP type, this is the URL.', 'type' => 'string', 'example' => 'http://www.example.com/.well-known/acme-challenge/pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow', 'title' => ''], + 'Value' => ['description' => 'The DCV content.', 'type' => 'string', 'example' => 'pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow.KfzYo4LH3EgOt7a73G-RqZkbR0eYtLfEUmtmqGmr4FQ', 'title' => ''], + 'Status' => ['description' => 'The validation status.', 'type' => 'string', 'example' => 'pending', 'title' => ''], ], 'title' => '', 'example' => '', @@ -54513,25 +30912,9 @@ 'title' => '', 'example' => '', ], - 'ApplyCode' => [ - 'description' => 'The error code returned for certificate application.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - 'title' => '', - ], - 'ApplyMessage' => [ - 'description' => 'The error message returned for certificate application.'."\n", - 'type' => 'string', - 'example' => 'canceled', - 'title' => '', - ], - 'KeyServerId' => [ - 'description' => 'Keyless server ID. Valid only when Type is keyless.', - 'type' => 'string', - 'example' => 'baba39055622c008b90285a8838e****'."\n", - 'title' => '', - ], + 'ApplyCode' => ['description' => 'The error code for the certificate application.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'ApplyMessage' => ['description' => 'The error message for the certificate application.', 'type' => 'string', 'example' => 'canceled', 'title' => ''], + 'KeyServerId' => ['description' => 'The Keyless server ID. This parameter is valid only when Type is set to keyless.', 'type' => 'string', 'example' => 'baba39055622c008b90285a8838e****'."\n", 'title' => ''], ], 'title' => '', 'example' => '', @@ -54546,44 +30929,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], ], - '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' => 'List Site Certificates', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query site certificate list', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListCertificates', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCertificates'], ], ], 'ramActions' => [ @@ -54594,27 +30953,18 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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\\": 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"}]', 'translator' => 'machine', ], 'ListCertificatesByRecord' => [ - 'summary' => 'Lists certificates that match specified records for a website. You can specify multiple records at a time.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the list of site certificates that match records. Batch record matching is supported.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -54627,237 +30977,82 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239262', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to query the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123'."\n", 'title' => ''], ], [ 'name' => 'RecordName', 'in' => 'query', - 'schema' => [ - 'description' => 'The record name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'www.example.com ', - 'title' => '', - ], + 'schema' => ['description' => 'The record name.', 'type' => 'string', 'required' => true, 'example' => 'www.example.com ', 'title' => ''], ], [ 'name' => 'ValidOnly', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to return only valid certificates. 0 indicates that all matched certificates are returned. 1 indicates that only valid certificates are returned.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to return only valid certificates.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'Detail', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to return the certificate details. 0 indicates that the certificate details are not returned. 1 indicates that the certificate details are returned.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to return certificate details.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '65C66B7B-671A-8297-9187-2R5477247B76', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of records that you specified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'The website ID,'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567890123', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com ', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '65C66B7B-671A-8297-9187-2R5477247B76', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries, which is the same as the number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com ', 'title' => ''], 'Result' => [ - 'description' => 'The queried certificates.'."\n", + 'description' => 'The result array.', 'type' => 'array', 'items' => [ - 'description' => 'Details of the certificates.'."\n", + 'description' => 'The result.', 'type' => 'object', 'properties' => [ - 'RecordName' => [ - 'description' => 'The name of the record.'."\n", - 'type' => 'string', - 'example' => 'www.example.com ', - 'title' => '', - ], - 'Count' => [ - 'description' => 'The number of certificates that match the specified records.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - 'title' => '', - ], + 'RecordName' => ['description' => 'The record name.', 'type' => 'string', 'example' => 'www.example.com ', 'title' => ''], + 'Count' => ['description' => 'The number of certificates that match the record.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], 'Certificates' => [ - 'description' => 'The certificates that match the specified records.'."\n", + 'description' => 'The list of certificates that match the record.', 'type' => 'array', 'items' => [ - 'description' => 'The queried certificate.'."\n", + 'description' => 'The certificate information.', 'type' => 'object', 'properties' => [ - 'CasId' => [ - 'description' => 'The certificate ID on Certificate Management Service.'."\n", - 'type' => 'string', - 'example' => '30000137', - 'title' => '', - ], - 'Id' => [ - 'description' => 'The ID of the certificate.'."\n", - 'type' => 'string', - 'example' => 'babab022c5e9b27bf9c64d7f4b1667f4', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The certificate name.'."\n", - 'type' => 'string', - 'example' => 'yourCertName', - 'title' => '', - ], - 'Region' => [ - 'description' => 'The region where the certificate is stored.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the certificate.'."\n", - 'type' => 'string', - 'example' => 'OK', - 'title' => '', - ], + 'CasId' => ['description' => 'The cloud certificate ID.', 'type' => 'string', 'example' => '30000137', 'title' => ''], + 'Id' => ['description' => 'The certificate ID.', 'type' => 'string', 'example' => 'babab022c5e9b27bf9c64d7f4b1667f4', 'title' => ''], + 'Name' => ['description' => 'The certificate name.', 'type' => 'string', 'example' => 'yourCertName', 'title' => ''], + 'Region' => ['description' => 'The certificate store area.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Status' => ['description' => 'The certificate status.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Type' => [ - 'description' => 'The type of the SSL certificate. Valid values:'."\n", + 'description' => 'The certificate type.', + 'enumValueTitles' => ['cas' => 'SSL Certificates Service certificate.', 'upload' => 'custom uploaded certificate.', 'keyless' => 'Keyless certificate.', 'free' => 'free certificate.'], 'type' => 'string', - 'enumValueTitles' => [ - 'cas' => '云盾证书', - 'upload' => '自定义上传证书', - 'keyless' => 'Keyless证书', - 'free' => '免费证书', - ], 'example' => 'free', 'title' => '', ], - 'CommonName' => [ - 'description' => 'The Common Name of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com ', - 'title' => '', - ], - 'NotBefore' => [ - 'description' => 'The time when the certificate takes effect.'."\n", - 'type' => 'string', - 'example' => '2023-02-28 06:17:11', - 'title' => '', - ], - 'NotAfter' => [ - 'description' => 'The time when the certificate expires.'."\n", - 'type' => 'string', - 'example' => '2024-02-28 06:17:11', - 'title' => '', - ], - 'Issuer' => [ - 'description' => 'The certificate authority (CA) that issued the certificate.'."\n", - 'type' => 'string', - 'example' => 'GlobalSign nv-sa', - 'title' => '', - ], - 'IssuerCN' => [ - 'description' => 'The Common Name of the certificate issuer.'."\n", - 'type' => 'string', - 'example' => 'GlobalSign Organization Validation CA - SHA256 - G3', - 'title' => '', - ], - 'SAN' => [ - 'description' => 'The Subject Alternative Name (SAN) of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com,*.example.com', - 'title' => '', - ], - 'SigAlg' => [ - 'description' => 'The signature algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'SHA256-RSA', - 'title' => '', - ], - 'PubAlg' => [ - 'description' => 'The public key algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'RSA', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2023-02-28 06:17:11', - 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'The update time.'."\n", - 'type' => 'string', - 'example' => '2023-02-28 06:17:11', - 'title' => '', - ], - 'SerialNumber' => [ - 'description' => 'The serial number of the certificate.'."\n", - 'type' => 'string', - 'example' => 'baba39055622c008b90285a8838ed09a', - 'title' => '', - ], - 'FingerprintSha256' => [ - 'description' => 'The SHA-256 fingerprint of the certificate.'."\n", - 'type' => 'string', - 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66', - 'title' => '', - ], - 'KeyServerId' => [ - 'description' => 'Keyless server ID. Valid when Type is keyless.', - 'type' => 'string', - 'example' => 'baba39055622c008b90285a8838e****'."\n", - 'title' => '', - ], + 'CommonName' => ['description' => 'The common name of the certificate.', 'type' => 'string', 'example' => 'www.example.com ', 'title' => ''], + 'NotBefore' => ['description' => 'The start time of the certificate validity period. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2023-02-28 06:17:11', 'title' => ''], + 'NotAfter' => ['description' => 'The end time of the certificate validity period. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-02-28 06:17:11', 'title' => ''], + 'Issuer' => ['description' => 'The certificate issuer.', 'type' => 'string', 'example' => 'GlobalSign nv-sa', 'title' => ''], + 'IssuerCN' => ['description' => 'The common name of the certificate issuer.', 'type' => 'string', 'example' => 'GlobalSign Organization Validation CA - SHA256 - G3', 'title' => ''], + 'SAN' => ['description' => 'The Subject Alternative Name (SAN) of the certificate.', 'type' => 'string', 'example' => 'www.example.com,*.example.com', 'title' => ''], + 'SigAlg' => ['description' => 'The signature algorithm of the certificate.', 'type' => 'string', 'example' => 'SHA256-RSA', 'title' => ''], + 'PubAlg' => ['description' => 'The public key algorithm of the certificate.', 'type' => 'string', 'example' => 'RSA', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2023-02-28 06:17:11', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2023-02-28 06:17:11', 'title' => ''], + 'SerialNumber' => ['description' => 'The certificate serial number.', 'type' => 'string', 'example' => 'baba39055622c008b90285a8838ed09a', 'title' => ''], + 'FingerprintSha256' => ['description' => 'The SHA-256 fingerprint of the certificate.', 'type' => 'string', 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66', 'title' => ''], + 'KeyServerId' => ['description' => 'The Keyless server ID. This parameter is valid only when Type is set to keyless.', 'type' => 'string', 'example' => 'baba39055622c008b90285a8838e****'."\n", 'title' => ''], ], 'title' => '', 'example' => '', @@ -54865,22 +31060,15 @@ 'title' => '', 'example' => '', ], - 'ApplylingCount' => [ - 'description' => 'The number of certificates that are being requested.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'title' => '', - ], + 'ApplylingCount' => ['description' => 'The number of certificates being applied for.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'Status' => [ - 'description' => 'Certificate configuration status. Possible values: none; configured; applying; failed.'."\n", + 'description' => 'The certificate configuration status of the record. Valid values:'."\n" + .'- none: Not configured.'."\n" + .'- configured: Configured.'."\n" + .'- applying: Being applied for.'."\n" + .'- failed: Application failed.', + 'enumValueTitles' => ['configured' => 'Configured.', 'applying' => 'Being applied for.', 'none' => 'Not configured.', 'failed' => 'Application failed.'], 'type' => 'string', - 'enumValueTitles' => [ - 'configured' => 'configured', - 'applying' => 'applying', - 'none' => 'none', - 'failed' => 'failed', - ], 'example' => 'none', 'title' => '', ], @@ -54898,54 +31086,23 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'Required parameter RecordName missing. Specify RecordName and try again.', - 'description' => 'Required parameter RecordName missing. Specify RecordName and try again.', - ], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'Required parameter RecordName missing. Specify RecordName and try again.', 'description' => 'Required parameter RecordName missing. Specify RecordName and try again.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + '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' => 'ListCertificatesByRecord', + 'title' => 'Query site certificates that match records', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListCertificatesByRecord', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCertificatesByRecord'], ], ], 'ramActions' => [ @@ -54956,26 +31113,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'translator' => 'machine', ], 'ListCiphers' => [ 'summary' => 'Query TLS Cipher Suite List', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -54988,22 +31135,14 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239324', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'CiphersGroup', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the cipher suite group, which can be: all, strict, custom.', - 'type' => 'string', - 'required' => true, - 'example' => 'strict', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the cipher suite group, which can be: all, strict, custom.', 'type' => 'string', 'required' => true, 'example' => 'strict', 'title' => ''], ], ], 'responses' => [ @@ -55013,34 +31152,13 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'Total number of cipher suites.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - 'title' => '', - ], - 'CiphersGroup' => [ - 'description' => 'Name of the cipher suite group.', - 'type' => 'string', - 'example' => 'all', - 'title' => '', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', 'title' => ''], + 'TotalCount' => ['description' => 'Total number of cipher suites.', 'type' => 'integer', 'format' => 'int64', 'example' => '16', 'title' => ''], + 'CiphersGroup' => ['description' => 'Name of the cipher suite group.', 'type' => 'string', 'example' => 'all', 'title' => ''], 'Result' => [ 'description' => 'Returned result.', 'type' => 'array', - 'items' => [ - 'description' => 'Cipher suite name', - 'type' => 'string', - 'example' => 'ECDHE-ECDSA-AES256-GCM-SHA384', - 'title' => '', - ], + 'items' => ['description' => 'Cipher suite name', 'type' => 'string', 'example' => 'ECDHE-ECDSA-AES256-GCM-SHA384', 'title' => ''], 'title' => '', 'example' => '', ], @@ -55051,32 +31169,17 @@ ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'ListCiphers', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListCiphers', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCiphers'], ], ], 'ramActions' => [ @@ -55087,24 +31190,16 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListClientCaCertificates' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Retrieves the list of client CA certificates for a specified site.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -55117,192 +31212,60 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239292', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Valid values: 1 to 500.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number to return. Valid values: 1 to 500.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 20. Maximum value: 100. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - 'title' => '', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567890123', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '16', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned data.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], 'Result' => [ - 'description' => 'The queried client CA certificates.'."\n", + 'description' => 'The list of client CA certificates.', 'type' => 'array', 'items' => [ - 'description' => 'The certificate information.'."\n", + 'description' => 'The certificate information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'example' => 'babab9db65ee5efcca9f3d41d4b5****', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The certificate name.'."\n", - 'type' => 'string', - 'example' => 'yourCertName', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The certificate status.'."\n", - 'type' => 'string', - 'example' => 'OK', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The certificate type.'."\n", - 'type' => 'string', - 'example' => 'upload', - 'title' => '', - ], - 'CommonName' => [ - 'description' => 'The Common Name of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com ', - 'title' => '', - ], - 'NotBefore' => [ - 'description' => 'The time when the certificate takes effect.'."\n", - 'type' => 'string', - 'example' => '2023-03-31 02:08:00', - 'title' => '', - ], - 'NotAfter' => [ - 'description' => 'The time when the certificate expires.'."\n", - 'type' => 'string', - 'example' => '2024-03-31 02:08:00', - 'title' => '', - ], - 'Issuer' => [ - 'description' => 'The CA that issued the certificate.'."\n", - 'type' => 'string', - 'example' => 'GlobalSign nv-sa', - 'title' => '', - ], - 'SAN' => [ - 'description' => 'The Subject Alternative Name (SAN) of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com,*.example.com', - 'title' => '', - ], - 'SignatureAlgorithm' => [ - 'description' => 'The signature algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'SHA256-RSA', - 'title' => '', - ], - 'PubkeyAlgorithm' => [ - 'description' => 'The public-key algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'RSA', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the certificate was created.'."\n", - 'type' => 'string', - 'example' => '2024-06-24 07:48:51', - 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'The time when the certificate was updated.'."\n", - 'type' => 'string', - 'example' => '2024-07-20 06:18:42', - 'title' => '', - ], - 'SerialNumber' => [ - 'description' => 'The certificate serial number.', - 'type' => 'string', - 'example' => 'babab022c5e9b27bf9c64d7f4b16****', - 'title' => '', - ], - 'FingerprintSha256' => [ - 'description' => 'Certificate SHA256 fingerprint. ', - 'type' => 'string', - 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', - 'title' => '', - ], + 'Id' => ['description' => 'The certificate ID.', 'type' => 'string', 'example' => 'babab9db65ee5efcca9f3d41d4b5****', 'title' => ''], + 'Name' => ['description' => 'The certificate name.', 'type' => 'string', 'example' => 'yourCertName', 'title' => ''], + 'Status' => ['description' => 'The certificate status.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Type' => ['description' => 'The certificate type.', 'type' => 'string', 'example' => 'upload', 'title' => ''], + 'CommonName' => ['description' => 'The common name of the certificate.', 'type' => 'string', 'example' => 'www.example.com ', 'title' => ''], + 'NotBefore' => ['description' => 'The start time of the certificate validity period. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2023-03-31 02:08:00', 'title' => ''], + 'NotAfter' => ['description' => 'The end time of the certificate validity period. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-03-31 02:08:00', 'title' => ''], + 'Issuer' => ['description' => 'The authority that issued the certificate.', 'type' => 'string', 'example' => 'GlobalSign nv-sa', 'title' => ''], + 'SAN' => ['description' => 'The Subject Alternative Name (SAN) of the certificate.', 'type' => 'string', 'example' => 'www.example.com,*.example.com', 'title' => ''], + 'SignatureAlgorithm' => ['description' => 'The signature algorithm of the certificate.', 'type' => 'string', 'example' => 'SHA256-RSA', 'title' => ''], + 'PubkeyAlgorithm' => ['description' => 'The public key algorithm of the certificate.', 'type' => 'string', 'example' => 'RSA', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-06-24 07:48:51', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-07-20 06:18:42', 'title' => ''], + 'SerialNumber' => ['description' => 'The certificate sequence number.', 'type' => 'string', 'example' => 'babab022c5e9b27bf9c64d7f4b16****', 'title' => ''], + 'FingerprintSha256' => ['description' => 'The SHA-256 fingerprint of the certificate.', 'type' => 'string', 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', 'title' => ''], ], 'title' => '', 'example' => '', @@ -55317,54 +31280,24 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'Obtain the client CA certificate list', - 'summary' => 'Retrieve the list of client CA certificates under the specified site. ', + 'staticInfo' => ['returnType' => 'synchronous'], + '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"}]', + 'title' => 'Get client CA certificate list', 'changeSet' => [ - [ - 'createdAt' => '2025-03-12T03:30:13.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-03-12T03:30:13.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListClientCaCertificates', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListClientCaCertificates'], ], ], 'ramActions' => [ @@ -55375,26 +31308,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => 'Queries client certificates configured for a website.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Retrieves the list of client certificates for a specified site.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -55407,198 +31330,61 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239148', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - 'title' => '', - ], - 'PageNumber' => [ - 'description' => 'The page number returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567890123', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned data.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], 'Result' => [ - 'description' => 'The client certificates.'."\n", + 'description' => 'The list of client certificates.', 'type' => 'array', 'items' => [ - 'description' => 'The queried certificate.'."\n", + 'description' => 'The certificate information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'example' => 'babab9db65ee5efcca9f3d41d4b50d66', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The certificate name.'."\n", - 'type' => 'string', - 'example' => 'yourCertName', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The certificate status.'."\n", - 'type' => 'string', - 'example' => 'active', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The certificate type.'."\n", - 'type' => 'string', - 'example' => 'dcdn', - 'title' => '', - ], - 'CommonName' => [ - 'description' => 'The Common Name of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com ', - 'title' => '', - ], - 'NotBefore' => [ - 'description' => 'The time when the certificate takes effect.'."\n", - 'type' => 'string', - 'example' => '2023-03-31 02:08:00', - 'title' => '', - ], - 'NotAfter' => [ - 'description' => 'The time when the certificate expires.'."\n", - 'type' => 'string', - 'example' => '2024-03-31 02:08:00', - 'title' => '', - ], - 'Issuer' => [ - 'description' => 'The certificate authority (CA) that issued the certificate.'."\n", - 'type' => 'string', - 'example' => 'GlobalSign nv-sa', - 'title' => '', - ], - 'SAN' => [ - 'description' => 'The Subject Alternative Name (SAN) of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com,*.example.com', - 'title' => '', - ], - 'SignatureAlgorithm' => [ - 'description' => 'The signature algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'SHA256-RSA', - 'title' => '', - ], - 'PubkeyAlgorithm' => [ - 'description' => 'The public key algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'RSA', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the certificate was created.'."\n", - 'type' => 'string', - 'example' => '2024-06-24 07:48:51', - 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'The time when the certificate was updated.'."\n", - 'type' => 'string', - 'example' => '2024-07-20 06:18:42', - 'title' => '', - ], - 'CACertificateId' => [ - 'description' => 'The ID of the CA certificate.'."\n", - 'type' => 'string', - 'example' => 'baba39055622c008b90285a8838ed09a', - 'title' => '', - ], - 'SerialNumber' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'FingerprintSha256' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'Id' => ['description' => 'The certificate ID.', 'type' => 'string', 'example' => 'babab9db65ee5efcca9f3d41d4b50d66', 'title' => ''], + 'Name' => ['description' => 'The certificate name.', 'type' => 'string', 'example' => 'yourCertName', 'title' => ''], + 'Status' => ['description' => 'The certificate status.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'Type' => ['description' => 'The certificate type.', 'type' => 'string', 'example' => 'dcdn', 'title' => ''], + 'CommonName' => ['description' => 'The common name of the certificate.', 'type' => 'string', 'example' => 'www.example.com ', 'title' => ''], + 'NotBefore' => ['description' => 'The start time of the certificate validity period. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2023-03-31 02:08:00', 'title' => ''], + 'NotAfter' => ['description' => 'The end time of the certificate validity period. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-03-31 02:08:00', 'title' => ''], + 'Issuer' => ['description' => 'The authority that issued the certificate.', 'type' => 'string', 'example' => 'GlobalSign nv-sa', 'title' => ''], + 'SAN' => ['description' => 'The Subject Alternative Name (SAN) of the certificate.', 'type' => 'string', 'example' => 'www.example.com,*.example.com', 'title' => ''], + 'SignatureAlgorithm' => ['description' => 'The signature algorithm of the certificate.', 'type' => 'string', 'example' => 'SHA256-RSA', 'title' => ''], + 'PubkeyAlgorithm' => ['description' => 'The public key algorithm of the certificate.', 'type' => 'string', 'example' => 'RSA', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-06-24 07:48:51', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-07-20 06:18:42', 'title' => ''], + 'CACertificateId' => ['description' => 'The CA certificate ID.', 'type' => 'string', 'example' => 'baba39055622c008b90285a8838ed09a', 'title' => ''], + 'SerialNumber' => ['description' => 'The certificate serial number.', 'type' => 'string', 'example' => 'babaded901474b9693acf530e0fb1d**', 'title' => ''], + 'FingerprintSha256' => ['description' => 'The SHA-256 fingerprint of the certificate.', 'type' => 'string', 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', 'title' => ''], ], 'title' => '', 'example' => '', @@ -55613,54 +31399,24 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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"}]', - 'title' => 'ListClientCertificates', + 'staticInfo' => ['returnType' => 'synchronous'], + '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\\": \\"babaded901474b9693acf530e0fb1d**\\",\\n \\"FingerprintSha256\\": \\"1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Get client certificate list', 'changeSet' => [ - [ - 'createdAt' => '2025-03-12T03:30:13.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-03-12T03:30:13.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListClientCertificates', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListClientCertificates'], ], ], 'ramActions' => [ @@ -55671,223 +31427,114 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], ], 'ListCompressionRules' => [ - 'summary' => 'Query the list of compression rules', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the list of compression rule configurations.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257666', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '34003500310****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '34003500310****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID, which can be obtained by calling the [ListRedirectRules](~~2867474~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID. You can call the [ListRedirectRules](~~2867474~~) operation to obtain the configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '35281609698****', 'title' => ''], ], [ 'name' => 'ConfigType', 'in' => 'query', 'schema' => [ - 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', - 'description' => 'Configuration type. Possible values:'."\n" - .'- global: Global configuration.'."\n" - .'- rule: Rule-based configuration.', + 'title' => '', + 'description' => 'The configuration type. Valid values:'."\n" + .'- global: global configuration.'."\n" + .'- rule: rule configuration.', + 'enumValueTitles' => ['rule' => 'rule configuration.', 'global' => 'global configuration.'], 'type' => 'string', + 'enum' => ['global', 'rule'], 'required' => false, 'example' => 'rule', - 'enum' => [ - 'global', - 'rule', - ], ], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - ], + 'schema' => ['title' => '', 'description' => 'The rule name. You do not need to set this parameter when adding a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '第几页，不传时默认为1', - 'description' => 'Page number.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number for a paged query. The value must be greater than or equal to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '每页几条，最大500，不传时默认500', - 'description' => 'Page size.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page for a paged query. Valid values: 1 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the effective version of the site configuration, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Request response result.', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n", - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n"], 'Configs' => [ - 'description' => 'List of compression rule configurations.', + 'description' => 'The list of compression rule configurations.', 'type' => 'array', 'items' => [ - 'description' => 'Details of the compression rule configuration.', + 'description' => 'The details of a compression rule configuration.', 'type' => 'object', 'properties' => [ - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '35281609698****'."\n", - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'Version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the effective version of the site configuration, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'Rule execution order. The smaller the value, the higher the priority.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Possible values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'Configuration type. Possible values:'."\n" - .'- global: Global configuration.'."\n" - .'- rule: Rule-based configuration.', - 'type' => 'string', - 'example' => 'rule', - 'title' => '', - ], - 'Gzip' => [ - 'description' => 'Gzip compression. Possible values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Brotli' => [ - 'description' => 'Brotli compression. Possible values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Zstd' => [ - 'description' => 'Zstd compression. Value range: - on: Enable. - off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '35281609698****'."\n", 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Sequence' => ['description' => 'The rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuleEnable' => ['description' => 'The rule switch. You do not need to set this parameter when adding a global configuration. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'The rule content, which uses a conditional expression to match user requests. You do not need to set this parameter when adding a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + .'- Match specified requests: Set the value to a custom expression, for example, (http.host eq \\"video.example.com\\").', 'type' => 'string', 'example' => '(http.host eq "video.example.com")', 'title' => ''], + 'RuleName' => ['description' => 'The rule name. You do not need to set this parameter when adding a global configuration.', 'type' => 'string', 'example' => 'rule_example', 'title' => ''], + 'ConfigType' => ['description' => 'The configuration type. Valid values:'."\n" + .'- global: global configuration.'."\n" + .'- rule: rule configuration.', 'type' => 'string', 'example' => 'rule', 'title' => ''], + 'Gzip' => ['description' => 'Gzip compression. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Brotli' => ['description' => 'Brotli compression. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Zstd' => ['description' => 'Zstd compression. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], ], 'title' => '', 'example' => '', @@ -55895,34 +31542,10 @@ 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'description' => 'Current page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'Page size.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'Total number of items.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - 'title' => '', - ], - 'TotalPage' => [ - 'description' => 'Total number of pages.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], + 'PageNumber' => ['description' => 'The current page number, which is the same as the PageNumber request parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'example' => '', ], @@ -55930,34 +31553,18 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], ], ], '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"}]', - 'title' => 'List Compression Rule Configurations', + 'title' => 'Query compression rule configurations', 'changeSet' => [ - [ - 'createdAt' => '2025-02-12T02:25:41.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-02-12T02:25:41.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListCompressionRules', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCompressionRules'], ], ], 'ramActions' => [ @@ -55968,27 +31575,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'operationType' => 'read', ], 'ListCustomHostnames' => [ - 'summary' => 'Queries the Software as a Service (SaaS) domain names for a site. This operation returns the ID, status, and domain validation information for each SaaS domain name. You can filter the results by the SaaS domain name, site ID, or the ID of the attached record.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the list of SaaS domain names under a site, including the ID, status, and domain name verification information of each SaaS domain name. You can filter results by SaaS domain name, site ID, or associated record ID.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -56001,67 +31597,37 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239634', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4DMKZ4', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4DMKZ4'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The site ID. Obtain this ID by calling the [ListSites](~~2850189~~) operation.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'title' => '', - 'example' => '744571165985008', - ], + 'schema' => ['title' => '', 'description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '744571165985008'], ], [ 'name' => 'RecordId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the attached record. Obtain this ID by calling the [ListRecords](~~2850265~~) operation.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'title' => '', - 'example' => '1234567890123', - ], + 'schema' => ['title' => '', 'description' => 'The associated record ID. You can call the [ListRecords](~~2850265~~) operation to obtain the record ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234567890123'], ], [ 'name' => 'Hostname', 'in' => 'query', - 'schema' => [ - 'description' => 'The SaaS domain name.', - 'type' => 'string', - 'title' => '', - 'required' => false, - 'example' => 'custom.site.com', - ], + 'schema' => ['title' => '', 'description' => 'The SaaS domain name.', 'type' => 'string', 'required' => false, 'example' => 'custom.site.com'], ], [ 'name' => 'NameMatchType', 'in' => 'query', 'schema' => [ - 'description' => 'The match pattern for searching SaaS domain names. The default value is \\`exact\\`.'."\n" - ."\n" - .'- **prefix**: Prefix match.'."\n" - ."\n" - .'- **suffix**: Suffix match.'."\n" - ."\n" - .'- **exact**: Exact match.'."\n" - ."\n" - .'- **fuzzy**: Fuzzy match.', - 'type' => 'string', - 'enum' => [ - 'prefix', - 'suffix', - 'exact', - 'fuzzy', - ], 'title' => '', + 'description' => 'The search match mode for the SaaS domain name. Default value: exact. Valid values:'."\n" + .'- **prefix**: prefix match.'."\n" + .'- **suffix**: suffix match.'."\n" + .'- **exact**: exact match.'."\n" + .'- **fuzzy**: fuzzy match.', + 'enumValueTitles' => ['prefix' => 'Prefix match.', 'exact' => 'Exact match.', 'suffix' => 'Suffix match.', 'fuzzy' => 'Fuzzy match.'], + 'type' => 'string', + 'enum' => ['prefix', 'suffix', 'exact', 'fuzzy'], 'required' => false, 'example' => 'exact', ], @@ -56070,23 +31636,15 @@ 'name' => 'Status', 'in' => 'query', 'schema' => [ - 'description' => 'The status of the SaaS domain name.'."\n" - ."\n" - .'- **pending**: Pending validation.'."\n" - ."\n" - .'- **active**: Active.'."\n" - ."\n" - .'- **conflicted**: Conflicted.'."\n" - ."\n" - .'- **offline**: Offline.', - 'type' => 'string', - 'enum' => [ - 'pending', - 'active', - 'conflicted', - 'offline', - ], 'title' => '', + 'description' => 'The SaaS domain name status. Valid values:'."\n" + .'- **pending**: pending verification.'."\n" + .'- **active**: activated.'."\n" + .'- **conflicted**: occupied.'."\n" + .'- **offline**: offline.', + 'enumValueTitles' => ['conflicted' => 'Occupied.', 'offline' => 'Offline.', 'pending' => 'Pending verification.', 'active' => 'Activated.'], + 'type' => 'string', + 'enum' => ['pending', 'active', 'conflicted', 'offline'], 'required' => false, 'example' => 'active', ], @@ -56094,26 +31652,12 @@ [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from 1. The default value is 1.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number for a paged query. The value must be greater than or equal to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. The default value is 100. The maximum value is 500.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page for a paged query. Valid values: 1 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '500'], ], ], 'responses' => [ @@ -56121,271 +31665,114 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.', - 'type' => 'string', + 'RequestId' => ['title' => '', 'description' => 'The request ID, which is a unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'], + 'PageNumber' => ['title' => '', 'description' => 'The current page number. This value is the same as the PageNumber request parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'TotalCount' => ['title' => '', 'description' => 'The total number of SaaS domain names.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Hostnames' => [ 'title' => '', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - ], - 'PageNumber' => [ - 'description' => 'The page number.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'example' => '100', - ], - 'TotalCount' => [ - 'description' => 'The total number of SaaS domain names.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'example' => '10', - ], - 'Hostnames' => [ + 'description' => 'The list of SaaS domain names returned.', 'type' => 'array', 'items' => [ + 'description' => 'The information about a single SaaS domain name.', 'type' => 'object', 'properties' => [ - 'HostnameId' => [ - 'description' => 'The ID of the SaaS domain name.', - 'type' => 'integer', - 'format' => 'int64', - 'title' => '', - 'example' => '1234567890123', - ], - 'Hostname' => [ - 'description' => 'The SaaS domain name.', - 'type' => 'string', - 'title' => '', - 'example' => 'custom.site.com', - ], - 'SiteId' => [ - 'description' => 'The site ID.', - 'type' => 'integer', - 'format' => 'int64', - 'title' => '', - 'example' => '890601022130656', - ], - 'SiteName' => [ - 'description' => 'The site name.', - 'type' => 'string', - 'title' => '', - 'example' => 'example.com', - ], - 'RecordId' => [ - 'description' => 'The record ID.', - 'type' => 'integer', - 'format' => 'int64', - 'title' => '', - 'example' => '3386032455886912', - ], - 'RecordName' => [ - 'description' => 'The record name.', - 'type' => 'string', - 'title' => '', - 'example' => 'origin.example.com', - ], + 'HostnameId' => ['title' => '', 'description' => 'The ID of the SaaS domain name.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123'], + 'Hostname' => ['title' => '', 'description' => 'The SaaS domain name.', 'type' => 'string', 'example' => 'custom.site.com'], + 'SiteId' => ['title' => '', 'description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '890601022130656'], + 'SiteName' => ['title' => '', 'description' => 'The site name.', 'type' => 'string', 'example' => 'example.com'], + 'RecordId' => ['title' => '', 'description' => 'The record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3386032455886912'], + 'RecordName' => ['title' => '', 'description' => 'The record name.', 'type' => 'string', 'example' => 'origin.example.com'], 'Status' => [ - 'description' => 'The status of the SaaS domain name.'."\n" - ."\n" - .'- **pending**: Pending validation.'."\n" - ."\n" - .'- **active**: Active.'."\n" - ."\n" - .'- **conflicted**: Conflicted.'."\n" - ."\n" - .'- **offline**: Offline.', - 'type' => 'string', - 'enum' => [ - 'pending', - 'active', - 'conflicted', - 'offline', - ], 'title' => '', + 'description' => 'The SaaS domain name status. Valid values:'."\n" + .'- **pending**: pending verification.'."\n" + .'- **active**: activated.'."\n" + .'- **conflicted**: occupied.'."\n" + .'- **offline**: offline.'."\n" + .'- **configuring**: being configured.', + 'enumValueTitles' => ['conflicted' => 'Occupied.', 'offline' => 'Offline.', 'configuring' => 'Being configured.', 'pending' => 'Pending verification.', 'active' => 'Activated.'], + 'type' => 'string', + 'enum' => ['pending', 'active', 'conflicted', 'offline', 'configuring'], 'example' => 'active', ], 'SslFlag' => [ - 'description' => 'The SSL switch.'."\n" - ."\n" + 'title' => '', + 'description' => 'The SSL switch. Valid values:'."\n" .'- **on**: SSL is enabled.'."\n" - ."\n" .'- **off**: SSL is disabled.', + 'enumValueTitles' => ['off' => 'SSL is disabled.', 'on' => 'SSL is enabled.'], 'type' => 'string', - 'enum' => [ - 'on', - 'off', - ], - 'title' => '', + 'enum' => ['on', 'off'], 'example' => 'on', ], 'CertType' => [ - 'description' => 'The certificate type.'."\n" - ."\n" - .'- **free**: Free certificate.'."\n" - ."\n" - .'- **upload**: Uploaded certificate.'."\n" - ."\n" - .'- **cas**: Alibaba Cloud Security certificate.', - 'type' => 'string', - 'enum' => [ - 'free', - 'upload', - 'cas', - ], - 'title' => '', - 'example' => 'free', - ], - 'CertHttpKey' => [ - 'description' => 'The HTTP URL for certificate validation.', - 'type' => 'string', - 'title' => '', - 'example' => 'http://custom.site.com/.well-known/acme-challenge/jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc', - ], - 'CertHttpValue' => [ - 'description' => 'The HTTP content for certificate validation.', - 'type' => 'string', 'title' => '', - 'example' => 'jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc.GridYdfJJB5PgFEL-t89XfaFvMPB4f2-I9fwLpKl6e0', - ], - 'CertTxtKey' => [ - 'description' => 'The TXT name for certificate validation.', - 'type' => 'string', - 'title' => '', - 'example' => ' '."\n" - .'_acme-challenge.custom.site.com'."\n", - ], - 'CertTxtValue' => [ - 'description' => 'The TXT content for certificate validation.', - 'type' => 'string', - 'title' => '', - 'example' => ' '."\n" - .'lcKYad3UQXgrZLvMm_6TBUYKK4xTkGmninV0Mzx4gjM'."\n", - ], - 'VerifyHost' => [ - 'description' => 'The TXT name for domain validation.', - 'type' => 'string', - 'title' => '', - 'example' => '_esa_custom_hostname.custom.site.com'."\n", - ], - 'VerifyCode' => [ - 'description' => 'The TXT content for domain validation.', + 'description' => 'The certificate type. Valid values:'."\n" + .'- **free**: free certificate.'."\n" + .'- **upload**: uploaded certificate.'."\n" + .'- **cas**: SSL Certificates Service certificate.', + 'enumValueTitles' => ['cas' => 'SSL Certificates Service certificate.', 'upload' => 'Uploaded certificate.', 'free' => 'Free certificate.'], 'type' => 'string', - 'title' => '', - 'example' => 'verify_16ab7f4d389d4dff6655f995c6a997bd'."\n", + 'enum' => ['free', 'upload', 'cas'], + 'example' => 'free', ], + 'CertHttpKey' => ['title' => '', 'description' => 'The HTTP address for certificate verification.', 'type' => 'string', 'example' => 'http://custom.site.com/.well-known/acme-challenge/jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc'], + 'CertHttpValue' => ['title' => '', 'description' => 'The HTTP content for certificate verification.', 'type' => 'string', 'example' => 'jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc.GridYdfJJB5PgFEL-t89XfaFvMPB4f2-I9fwLpKl6e0'], + 'CertTxtKey' => ['title' => '', 'description' => 'The TXT record name for certificate verification.', 'type' => 'string', 'example' => ' '."\n" + .'_acme-challenge.custom.site.com'."\n"], + 'CertTxtValue' => ['title' => '', 'description' => 'The TXT record content for certificate verification.', 'type' => 'string', 'example' => ' '."\n" + .'lcKYad3UQXgrZLvMm_6TBUYKK4xTkGmninV0Mzx4gjM'."\n"], + 'VerifyHost' => ['title' => '', 'description' => 'The TXT record name for domain name verification.', 'type' => 'string', 'example' => '_esa_custom_hostname.custom.site.com'."\n"], + 'VerifyCode' => ['title' => '', 'description' => 'The TXT record content for domain name verification.', 'type' => 'string', 'example' => 'verify_16ab7f4d389d4dff6655f995c6a997bd'."\n"], 'CertStatus' => [ - 'description' => 'The certificate status.'."\n" - ."\n" - .'- **OK**: Normal.'."\n" - ."\n" - .'- **Applying**: Applying.'."\n" - ."\n" - .'- **ApplyFailed**: Application failed.'."\n" - ."\n" - .'- **Expiring**: Expiring soon.'."\n" - ."\n" - .'- **Expired**: Expired.', - 'type' => 'string', - 'enum' => [ - 'OK', - 'Expired', - 'Expiring', - 'Applying', - 'ApplyFailed', - ], - 'title' => '', - 'example' => 'OK', - ], - 'CertNotAfter' => [ - 'description' => 'The expiration time of the certificate. The date is in the ISO 8601 format and uses UTC. The format is \\`yyyy-MM-ddTHH:mm:ssZ\\`.', - 'type' => 'string', 'title' => '', - 'example' => '2026-04-19T11:15:20Z'."\n", - ], - 'CertApplyMessage' => [ - 'description' => 'The error description for the free certificate application.', + 'description' => 'The certificate status. Valid values:'."\n" + .'- **OK**: normal.'."\n" + .'- **Applying**: being applied.'."\n" + .'- **ApplyFailed**: application failed.'."\n" + .'- **Expiring**: about to expire.'."\n" + .'- **Expired**: expired.', + 'enumValueTitles' => ['Expiring' => 'About to expire.', 'ApplyFailed' => 'Application failed.', 'Expired' => 'Expired.', 'Applying' => 'Being applied.', 'OK' => 'Normal.'], 'type' => 'string', - 'title' => '', - 'example' => 'canceled', - ], - 'CertApplyCode' => [ - 'description' => 'The error code for the free certificate application.', - 'type' => 'integer', - 'format' => 'int64', - 'title' => '', - 'example' => '2'."\n", + 'enum' => ['OK', 'Expired', 'Expiring', 'Applying', 'ApplyFailed'], + 'example' => 'OK', ], + 'CertNotAfter' => ['title' => '', 'description' => 'The certificate expiration time, in the ISO 8601 standard in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2026-04-19T11:15:20Z'."\n"], + 'CertApplyMessage' => ['title' => '', 'description' => 'The error message for the free certificate application.', 'type' => 'string', 'example' => 'canceled'], + 'CertApplyCode' => ['title' => '', 'description' => 'The error code for the free certificate application.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'."\n"], 'OfflineReason' => [ - 'description' => 'The reason why the SaaS domain name was taken offline.'."\n" - ."\n" - .'- **expiration\\_arrears**: The subscription plan expired or the account has an overdue payment.'."\n" - ."\n" - .'- **internally\\_disabled**: Disabled by the system.'."\n" - ."\n" - .'- **missing\\_icp**: The domain name lacks an ICP filing.'."\n" - ."\n" - .'- **content\\_violation**: Content violation.'."\n" - ."\n" - .'- **proactively\\_disabled**: Disabled by you or because the usage cap was reached.', - 'type' => 'string', - 'enum' => [ - 'proactively_disabled', - 'content_violation', - 'internally_disabled', - 'missing_icp', - 'expiration_arrears', - ], 'title' => '', + 'description' => 'The reason why the SaaS domain name was taken offline. Valid values:'."\n" + .'- **expiration_arrears**: the subscription plan expired or the account has an overdue payment.'."\n" + .'- **internally_disabled**: disabled by the system.'."\n" + .'- **missing_icp**: the domain name does not have an ICP filing.'."\n" + .'- **content_violation**: content violation.'."\n" + .'- **proactively_disabled**: proactively disabled by you or disabled because the usage cap you configured was reached.', + 'enumValueTitles' => ['expiration_arrears' => 'The subscription plan expired or the account has an overdue payment.', 'proactively_disabled' => 'Proactively disabled by you or disabled because the usage cap was reached.', 'content_violation' => 'Content violation.', 'internally_disabled' => 'Disabled by the system.', 'missing_icp' => 'The domain name does not have an ICP filing.'], + 'type' => 'string', + 'enum' => ['proactively_disabled', 'content_violation', 'internally_disabled', 'missing_icp', 'expiration_arrears'], 'example' => 'missing_icp', ], 'ConflictWith' => [ - 'description' => 'The reason why the SaaS domain name is conflicted.'."\n" - ."\n" - .'- **existing\\_custom\\_hostname**: Conflicts with an existing SaaS domain name.'."\n" - ."\n" - .'- **existing\\_record**: Conflicts with an existing site record.'."\n" - ."\n" - .'- **existing\\_load\\_balancer**: Conflicts with an existing load balancer.'."\n" - ."\n" - .'- **existing\\_origin\\_pool**: Conflicts with an existing origin pool.', - 'type' => 'string', - 'enum' => [ - 'existing_custom_hostname', - 'existing_site', - 'existing_record', - 'existing_load_balancer', - 'existing_origin_pool', - ], - 'title' => '', - 'example' => 'existing_custom_hostname', - ], - 'CreateTime' => [ - 'description' => 'The creation time of the SaaS domain name. The date is in the ISO 8601 format and uses UTC. The format is \\`yyyy-MM-ddTHH:mm:ssZ\\`.', - 'type' => 'string', 'title' => '', - 'example' => '2026-04-19T11:15:20Z', - ], - 'UpdateTime' => [ - 'description' => 'The update time of the SaaS domain name. The date is in the ISO 8601 format and uses UTC. The format is \\`yyyy-MM-ddTHH:mm:ssZ\\`.', + 'description' => 'The reason why the SaaS domain name is occupied. Valid values:'."\n" + .'- **existing_custom_hostname**: conflicts with an existing SaaS domain name.'."\n" + .'- **existing_site**: conflicts with an existing site.'."\n" + .'- **existing_record**: conflicts with an existing site record.'."\n" + .'- **existing_load_balancer**: conflicts with an existing load balancing instance.'."\n" + .'- **existing_origin_pool**: conflicts with an existing origin IPAM pool.', + 'enumValueTitles' => ['existing_load_balancer' => 'Conflicts with an existing load balancing instance.', 'existing_custom_hostname' => 'Conflicts with an existing SaaS domain name.', 'existing_site' => 'Conflicts with an existing site.', 'existing_record' => 'Conflicts with an existing site record.', 'existing_origin_pool' => 'Conflicts with an existing origin pool.'], 'type' => 'string', - 'title' => '', - 'example' => '2026-04-19T11:15:20Z', + 'enum' => ['existing_custom_hostname', 'existing_site', 'existing_record', 'existing_load_balancer', 'existing_origin_pool'], + 'example' => 'existing_custom_hostname', ], + 'CreateTime' => ['title' => '', 'description' => 'The creation time of the SaaS domain name, in the ISO 8601 standard in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2026-04-19T11:15:20Z'], + 'UpdateTime' => ['title' => '', 'description' => 'The update time of the SaaS domain name, in the ISO 8601 standard in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2026-04-19T11:15:20Z'], ], - 'description' => 'The information about a single SaaS domain name.', 'title' => '', 'example' => '', ], - 'title' => '', - 'description' => 'The list of SaaS domain names.', 'example' => '', ], ], @@ -56397,52 +31784,41 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], ], 404 => [ - [ - 'errorCode' => 'CustomHostname.NotFound', - 'errorMessage' => 'The custom hostname does not exist. Modify it and try again.', - 'description' => 'The custom hostname does not exist. Modify it and try again.', - ], - [ - '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' => '', - ], + ['errorCode' => 'CustomHostname.NotFound', 'errorMessage' => 'The custom hostname does not exist. Modify it and try again.', 'description' => 'The custom hostname does not exist. Modify it and try again.'], + ['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' => 'ListCustomHostnames', + 'title' => 'Query saaS domain names', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomHostnames'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListCustomHostnames', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], + ], + ], ], - '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' => 'List the custom response code configurations for the site.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Query the list of custom response code configurations for a site.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -56455,50 +31831,31 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257649', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The site ID. For more information, see [ListSites](~~2850189~~).', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '340035003106221', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '340035003106221', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '436490043994112', - 'title' => '', - ], + 'schema' => ['description' => 'Configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '436490043994112', 'title' => ''], ], [ 'name' => 'ConfigType', 'in' => 'query', 'schema' => [ - 'description' => 'The configuration type. Use this parameter to query global or rule configurations. Valid values:'."\n" - ."\n" - .'- global: Queries global configurations.'."\n" + 'title' => '', + 'description' => 'Configuration type. You can use this parameter to query global or rule configurations. Valid values:'."\n" ."\n" - .'- rule: Queries rule configurations.', + .'- global: queries global configurations.'."\n" + .'- rule: queries rule configurations.', + 'enumValueTitles' => ['rule' => 'Rule configuration', 'global' => 'Global configuration'], 'type' => 'string', - 'enum' => [ - 'global', - 'rule', - ], - 'title' => '', + 'enum' => ['global', 'rule'], 'required' => false, 'example' => 'global', ], @@ -56506,210 +31863,263 @@ [ 'name' => 'RuleName', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Rule name.', 'type' => 'string', 'required' => false, 'example' => 'rule_example'."\n"], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => ['description' => 'The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Number of entries per page. Maximum value: 500. Default value: 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The rule name.', - 'type' => 'string', 'title' => '', - 'required' => false, - 'example' => 'rule_example'."\n", + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], + 'Configs' => [ + 'description' => 'The list of custom response code configurations.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a custom response code configuration.', + 'type' => 'object', + 'properties' => [ + 'ConfigId' => ['description' => 'Configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '395386449776640', 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Sequence' => ['description' => 'The execution order of the rule. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Rule' => ['description' => 'The rule content, which uses conditional expressions to match user requests. You do not need to set this parameter when adding a global configuration. Two usage scenarios are supported:'."\n" + .'- Match all incoming requests: set the value to true.'."\n" + .'- Match specific requests: set the value to a custom expression, for example: (http.host eq \\"video.example.com\\").', 'type' => 'string', 'example' => '(http.host eq "video.example.com")', 'title' => ''], + 'RuleEnable' => ['description' => 'The rule switch. You do not need to set this parameter when adding a global configuration. Valid values:'."\n" + .'- on: enables the rule.'."\n" + .'- off: disables the rule.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'RuleName' => ['description' => 'The rule name. You do not need to set this parameter when adding a global configuration.', 'type' => 'string', 'example' => 'rule_example', 'title' => ''], + 'ConfigType' => ['description' => 'The configuration type. Valid values:'."\n" + .'- global: global configuration.'."\n" + .'- rule: rule configuration.', 'type' => 'string', 'example' => 'global', 'title' => ''], + 'ReturnCode' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'PageId' => ['description' => 'The response page.', 'type' => 'string', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'PageNumber' => ['description' => 'Page number. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'Page size. Default value: 500. Valid values: 1 to 500.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'Total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalPage' => ['description' => 'Total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ], + ], + 'title' => 'Query custom response code configuration list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomResponseCodeRules'], + ], + ], + 'ramActions' => [ [ - 'name' => 'SiteVersion', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListCustomResponseCodeRules', + '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 \\"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"}]', + ], + 'ListDDoSInstances' => [ + 'summary' => 'Retrieves a list of purchased DDoS protection instances.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239352', + 'abilityTreeNodes' => ['FEATUREdcdnZA9EPX'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SortBy', 'in' => 'query', + 'allowEmptyValue' => false, 'schema' => [ - 'description' => 'The version number of the site configuration. For sites with configuration version control enabled, specify the site version for which the configuration takes effect using this parameter. The default value is version 0.', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'Sort field. Default: CreateTime.'."\n" + ."\n" + .'- **CreateTime**: Time when the instance was purchased.', + 'enumValueTitles' => ['CreateTime' => 'CreateTime'], + 'type' => 'string', + 'enum' => ['CreateTime', 'default'], 'required' => false, - 'example' => '0', + 'example' => 'CreateTime', 'title' => '', ], ], [ - 'name' => 'PageNumber', + 'name' => 'SortOrder', 'in' => 'query', 'schema' => [ - 'description' => 'The page number. The default value is 1 if you do not specify this parameter.', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'Sort order:'."\n" + ."\n" + .'- asc: ascending.'."\n" + ."\n" + .'- desc: descending.', + 'type' => 'string', + 'enum' => ['asc', 'desc'], 'title' => '', 'required' => false, - 'example' => '1', + 'example' => 'asc', ], ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'Page number. Default: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], [ 'name' => 'PageSize', 'in' => 'query', + 'schema' => ['description' => 'Number of entries per page. Default: 20. Maximum: 500. Valid values: integers from 1 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', 'schema' => [ - 'description' => 'The number of entries per page. The maximum value is 500. The default value is 500 if you do not specify this parameter.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', + 'description' => 'Instance status.', + 'enumValueTitles' => ['offline' => 'offline', 'overdue' => 'overdue', 'disable' => 'disable', 'online' => 'online'], + 'type' => 'string', + 'enum' => ['online', 'overdue', 'disable'], 'required' => false, - 'example' => '20', + 'example' => 'online', + 'title' => '', ], ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => false, 'example' => 'esa-ddos-b1e0l80ugfeo', 'title' => ''], + ], + [ + 'name' => 'SiteInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'Associated site package instance ID.', 'type' => 'string', 'required' => false, 'example' => 'esa-site-a71k7bw1adf', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The request response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], - 'Configs' => [ - 'description' => 'You can modify the response code configuration list.', + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => '9F1DC265-BF10-5C9C-B607-760265C5F365'], + 'InstanceInfo' => [ 'type' => 'array', 'items' => [ - 'description' => 'The details of the custom response code configuration.', 'type' => 'object', 'properties' => [ - 'ConfigId' => [ - 'description' => 'The configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '395386449776640', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'The version number of the site configuration. For sites with configuration version control enabled, this parameter specifies the site version for which the configuration takes effect. The default value is version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'The rule execution order. A smaller value indicates higher priority.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'The rule content. Use a conditional expression to match user requests. Do not set this parameter when adding a global configuration. There are two scenarios:'."\n" - ."\n" - .'- Match all incoming requests: Set the value to true.'."\n" - ."\n" - .'- Match specific requests: Set the value to a custom expression, such as (http.host eq "video.example.com").', - 'type' => 'string', - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'The rule switch. Do not set this parameter when adding a global configuration. Valid values:'."\n" - ."\n" - .'- on: Enabled.'."\n" - ."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'The rule name. Do not set this parameter when adding a global configuration.', - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'The configuration type. Valid values:'."\n" - ."\n" - .'- global: Global configuration.'."\n" - ."\n" - .'- rule: Rule configuration.', - 'type' => 'string', - 'example' => 'global', - 'title' => '', - ], - 'ReturnCode' => [ - 'description' => 'The response code.', - 'type' => 'string', - 'example' => '200', - 'title' => '', - ], - 'PageId' => [ - 'description' => 'The response page.', - 'type' => 'string', - 'example' => '0', - 'title' => '', - ], + 'InstanceId' => ['description' => 'Instance ID', 'type' => 'string', 'example' => 'sp-ddddxxxxx', 'title' => ''], + 'CreateTime' => ['description' => 'Time when the instance was purchased', 'type' => 'string', 'example' => '2025-07-01T07:59:07Z', 'title' => ''], + 'Status' => ['description' => 'Instance status. Valid values:'."\n" + ."\n" + .'- **online**: Normal service status.'."\n" + ."\n" + .'- **offline**: Expired but not overdue. Instance is unavailable.'."\n" + ."\n" + .'- **disable**: Released.'."\n" + ."\n" + .'- **overdue**: Service suspended due to overdue payment.', 'type' => 'string', 'example' => 'online', 'title' => ''], + 'DDoSBurstableDomesticProtection' => ['description' => 'DDoS protection specification for the Chinese mainland', 'type' => 'string', 'example' => 'cn_300', 'title' => ''], + 'DDoSBurstableOverseasProtection' => ['description' => 'DDoS protection specification for regions outside the Chinese mainland', 'type' => 'string', 'example' => 'overseas_300', 'title' => ''], + 'SiteInstanceId' => ['description' => 'Associated site package instance ID', 'type' => 'string', 'example' => 'esa-site-b0s6kmx0r0n4', 'title' => ''], + 'ReserveReleaseTime' => ['description' => 'Scheduled release time', 'type' => 'string', 'example' => '2026-03-25T16:00:00Z', 'title' => ''], ], + 'description' => 'Instance details', 'title' => '', 'example' => '', ], + 'description' => 'Instance details', 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'description' => 'The page number. Default value: **1**.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The page size. Default value: 500. Valid values: 1 to 500.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'TotalPage' => [ - 'description' => 'The total number of pages.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], + 'PageNumber' => ['description' => 'Page number. Default: **1**.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'Number of entries per page', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'Total number of entries', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'TotalPage' => ['description' => 'Total number of pages', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], + 'title' => '', + 'description' => 'Response schema', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], ], ], - 'title' => 'ListCustomResponseCodeRules', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListDDoSInstances', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDDoSInstances'], + ], ], - '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"}]', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListDDoSInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9F1DC265-BF10-5C9C-B607-760265C5F365\\",\\n \\"InstanceInfo\\": [\\n {\\n \\"InstanceId\\": \\"sp-ddddxxxxx\\",\\n \\"CreateTime\\": \\"2025-07-01T07:59:07Z\\",\\n \\"Status\\": \\"online\\",\\n \\"DDoSBurstableDomesticProtection\\": \\"cn_300\\",\\n \\"DDoSBurstableOverseasProtection\\": \\"overseas_300\\",\\n \\"SiteInstanceId\\": \\"esa-site-b0s6kmx0r0n4\\",\\n \\"ReserveReleaseTime\\": \\"2026-03-25T16:00:00Z\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"TotalPage\\": 2\\n}","type":"json"}]', ], 'ListESAIPInfo' => [ 'summary' => 'Batch query whether the IP address is included in the ESA resolution result.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -56722,9 +32132,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '243691', - 'abilityTreeNodes' => [ - 'FEATUREdcdnWQK30N', - ], + 'abilityTreeNodes' => ['FEATUREdcdnWQK30N'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ @@ -56732,52 +32140,32 @@ 'name' => 'VipInfo', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '', - 'description' => 'You can enter IPv4 or IPv6 addresses. Separate multiple IP addresses with commas (,). You can enter up to 20 IP addresses at a time.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '192.0.0.24,2408:8740:41FF:2:23::7FE,0.0.0.0,abcd', - ], + 'schema' => ['description' => 'You can enter IPv4 or IPv6 addresses. Separate multiple IP addresses with commas (,). You can enter up to 20 IP addresses at a time.', 'type' => 'string', 'required' => true, 'title' => '', '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'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n" - ."\n" - .'Example D03F9502-6653-127C-8A5F-0647197\\*\\*\\*\\*\\*'."\n", - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.'."\n" + ."\n" + .'Example D03F9502-6653-127C-8A5F-0647197\\*\\*\\*\\*\\*', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', 'title' => ''], 'Content' => [ - 'description' => 'The objects that are returned.'."\n", + 'description' => 'The objects that are returned.', 'type' => 'array', 'items' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'Ip' => [ - 'description' => 'The IP addresses.'."\n", - 'type' => 'string', - 'example' => '27.129.167.239', - 'title' => '', - ], - 'CdnIp' => [ - 'description' => 'Whether the IP address in the parameter belongs to ESA POPs.'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'string', - 'example' => 'true', - 'title' => '', - ], + 'Ip' => ['description' => 'The IP addresses.', 'type' => 'string', 'example' => '27.129.167.239', 'title' => ''], + 'CdnIp' => ['description' => 'Whether the IP address in the parameter belongs to ESA POPs.'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**', 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', @@ -56790,23 +32178,19 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - '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"}]', 'title' => 'ListESAIPInfo', - 'description' => '此接口用检测参数vipInfo集合中的vs_addr是否为vip。', - 'requestParamsDescription' => '参数为必传，不可为空。', - 'responseParamsDescription' => 'Ip为vipInfo中的vs_addr地址，CdnIp为判断结果', + 'description' => 'Checks whether vs\\_addr values in the vipInfo collection are VIPs.', + 'requestParamsDescription' => 'This parameter is required and cannot be empty.', + 'responseParamsDescription' => 'Ip is the vs\\_addr address in vipInfo. CdnIp is the check result.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '50', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListESAIPInfo', - ], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListESAIPInfo'], ], ], 'ramActions' => [ @@ -56817,31 +32201,18 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], + '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' => 'Retrieve the list of image secrets for edge container applications', + 'summary' => 'Retrieves the list of image secrets for an edge container application.', 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -56853,60 +32224,33 @@ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'Application ID, which can be obtained using the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) interface.', - 'type' => 'string', - 'required' => true, - 'example' => 'app-88068867578379****', - 'title' => '', - ], + 'schema' => ['description' => 'The application ID. You can call the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation to obtain the application ID.'."\n" + .'>The AppId format is the prefix app- followed by a numeric suffix, with a total length of 20 to 64 characters (example: app-8806886***83794688). Call ListEdgeContainerApps to obtain an existing AppId, or call CreateEdgeContainerApp to create an application first..', 'type' => 'string', 'required' => true, 'example' => 'app-88068867578379****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '3558df77-8a7a-4060-a900-2d7949403836', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '3558df77-8a7a-4060-a900-2d7949403836'], 'ImageSecretList' => [ - 'description' => 'List of image secrets.', + 'description' => 'The list of image secrets.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'Name of the image secret.', - 'type' => 'string', - 'example' => 'reg-123****', - 'title' => '', - ], - 'Registry' => [ - 'description' => 'Registry address.', - 'type' => 'string', - 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com', - 'title' => '', - ], - 'Username' => [ - 'description' => 'Username for the image repository', - 'type' => 'string', - 'example' => 'admin', - 'title' => '', - ], + 'Name' => ['description' => 'The name of the image secret.', 'type' => 'string', 'example' => 'reg-123****', 'title' => ''], + 'Registry' => ['description' => 'The image repository address.', 'type' => 'string', 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com', 'title' => ''], + 'Username' => ['description' => 'The username of the image repository.', 'type' => 'string', 'example' => 'admin', 'title' => ''], ], 'description' => '', 'title' => '', @@ -56922,72 +32266,30 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', - 'description' => 'Invalid parameter. Check the parameter configuration.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], - [ - 'errorCode' => 'InvalidParameter.Appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the input application ID is incorrect. You can use the ListEdgeContainerApps API to obtain the application ID.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', 'description' => 'Invalid parameter. Check the parameter configuration.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['errorCode' => 'InvalidParameter.Appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the input application ID is incorrect. You can use the ListEdgeContainerApps API to obtain the application ID.'], ], 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'Get Edge Container Application Image Secrets List', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve image secret list for edge container application', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [ - [ - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:ListEdgeContainerAppImageSecrets', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEdgeContainerAppImageSecrets'], ], ], + 'ramActions' => [], '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' => 'Lists domain names that are associated with a containerized application.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -56999,88 +32301,44 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239590', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'app-88068867578379****', - 'maxLength' => 64, - 'minLength' => 20, - 'title' => '', - ], + 'schema' => ['description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'app-88068867578379****', 'maxLength' => 64, 'minLength' => 20, 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Valid values: **1** to **100000**. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number. Valid values: **1** to **100000**. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 500.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 500.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'OrderKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The sorting field. Valid values:'."\n" - ."\n" - .'* CreateTime: the time when the domain name was associated.'."\n" - .'* CreateTime: the time when the domain name was last modified.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CreateTime', - 'default' => 'CreateTime', - 'title' => '', - ], + 'schema' => ['description' => 'The sorting field. Valid values:'."\n" + ."\n" + .'* CreateTime: the time when the domain name was associated.'."\n" + .'* CreateTime: the time when the domain name was last modified.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CreateTime', 'default' => 'CreateTime', 'title' => ''], ], [ 'name' => 'OrderType', 'in' => 'query', - 'schema' => [ - 'description' => 'The order in which you want to sort the query results. Valid values:'."\n" - ."\n" - .'* ASC: in ascending order.'."\n" - .'* DESC: in descending order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', - 'default' => 'Desc', - 'title' => '', - ], + 'schema' => ['description' => 'The order in which you want to sort the query results. Valid values:'."\n" + ."\n" + .'* ASC: in ascending order.'."\n" + .'* DESC: in descending order.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DESC', 'default' => 'Desc', 'title' => ''], ], [ 'name' => 'SearchKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword that is used for the search.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ver-1006157458290860032', - 'title' => '', - ], + 'schema' => ['description' => 'The keyword that is used for the search.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ver-1006157458290860032', 'title' => ''], ], ], 'responses' => [ @@ -57088,97 +32346,25 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', - 'title' => '', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The number of domain names that are associated with the specified application.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The number of domain names that are associated with the specified application.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'Records' => [ 'description' => 'The details about the associated domain names.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'AppId' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'example' => 'app-88068867578379****', - 'title' => '', - ], - 'Cname' => [ - 'description' => 'The CNAME of the associated domain name.'."\n", - 'type' => 'string', - 'example' => 'kdxceo****.yun****.com', - 'title' => '', - ], - 'ConfigId' => [ - 'description' => 'The configuration ID of the associated domain name.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '27522948436****', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the domain name was added. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-12-24T02:01:11Z', - 'title' => '', - ], - 'RecordId' => [ - 'description' => 'The record ID of the associated domain name.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '266****', - 'title' => '', - ], - 'RecordName' => [ - 'description' => 'The associated domain name.'."\n", - 'type' => 'string', - 'example' => 'a.example.com', - 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'The time when the scheduling domain ID or CNAME was last modified. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2021-12-22T08:32:02Z', - 'title' => '', - ], - 'SchemdId' => [ - 'description' => 'The scheduling domain ID of the associated domain name.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '123456', - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5407498413****', - 'title' => '', - ], + 'AppId' => ['description' => 'The application ID.'."\n", 'type' => 'string', 'example' => 'app-88068867578379****', 'title' => ''], + 'Cname' => ['description' => 'The CNAME of the associated domain name.'."\n", 'type' => 'string', 'example' => 'kdxceo****.yun****.com', 'title' => ''], + 'ConfigId' => ['description' => 'The configuration ID of the associated domain name.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '27522948436****', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the domain name was added. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2023-12-24T02:01:11Z', 'title' => ''], + 'RecordId' => ['description' => 'The record ID of the associated domain name.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '266****', 'title' => ''], + 'RecordName' => ['description' => 'The associated domain name.'."\n", 'type' => 'string', 'example' => 'a.example.com', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the scheduling domain ID or CNAME was last modified. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2021-12-22T08:32:02Z', 'title' => ''], + 'SchemdId' => ['description' => 'The scheduling domain ID of the associated domain name.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '123456', 'title' => ''], + 'SiteId' => ['description' => 'The website ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5407498413****', 'title' => ''], ], 'description' => '', 'title' => '', @@ -57196,30 +32382,14 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InvalidParameter.appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.'], ], 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], 'eventInfo' => [ @@ -57229,19 +32399,11 @@ '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"}]', 'title' => 'ListEdgeContainerAppRecords', 'changeSet' => [ - [ - 'createdAt' => '2024-09-18T06:56:38.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-18T06:56:38.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListEdgeContainerAppRecords', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEdgeContainerAppRecords'], ], ], 'ramActions' => [ @@ -57252,12 +32414,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -57265,13 +32422,8 @@ ], 'ListEdgeContainerAppVersions' => [ 'summary' => 'Lists versions of all containerized applications.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -57283,100 +32435,50 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239225', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'app-88068867578379****', - 'maxLength' => 64, - 'minLength' => 20, - 'title' => '', - ], + 'schema' => ['description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.'."\n", 'type' => 'string', 'required' => true, 'example' => 'app-88068867578379****', 'maxLength' => 64, 'minLength' => 20, 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Valid values: 1 to 65535.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number. Valid values: 1 to 65535.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'OrderKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The sorting field. Valid values:'."\n" - ."\n" - .'* Name: the version name.'."\n" - .'* CreateTime: the time when the version was created.'."\n" - .'* UpdateTime: the time when the version was last modified.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Name', - 'default' => 'CreateTime', - 'title' => '', - ], + 'schema' => ['description' => 'The sorting field. Valid values:'."\n" + ."\n" + .'* Name: the version name.'."\n" + .'* CreateTime: the time when the version was created.'."\n" + .'* UpdateTime: the time when the version was last modified.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Name', 'default' => 'CreateTime', 'title' => ''], ], [ 'name' => 'OrderType', 'in' => 'query', - 'schema' => [ - 'description' => 'The order in which you want to sort the query results. Valid values:'."\n" - ."\n" - .'* ASC: in ascending order.'."\n" - .'* DESC: in descending order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Desc', - 'default' => 'Desc', - 'title' => '', - ], + 'schema' => ['description' => 'The order in which you want to sort the query results. Valid values:'."\n" + ."\n" + .'* ASC: in ascending order.'."\n" + .'* DESC: in descending order.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Desc', 'default' => 'Desc', 'title' => ''], ], [ 'name' => 'SearchType', 'in' => 'query', - 'schema' => [ - 'description' => 'The parameter used for fuzzy search. Valid values: VersionId and Name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'VersionId', - 'title' => '', - ], + 'schema' => ['description' => 'The parameter used for fuzzy search. Valid values: VersionId and Name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'VersionId', 'title' => ''], ], [ 'name' => 'SearchKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword used for the search.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ver-100568263967926****', - 'title' => '', - ], + 'schema' => ['description' => 'The keyword used for the search.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ver-100568263967926****', 'title' => ''], ], ], 'responses' => [ @@ -57384,33 +32486,10 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', - 'title' => '', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F61CDR30-E83C-4FDA-BF73-9A94CDD44229', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'Versions' => [ 'description' => 'The versions.'."\n", 'type' => 'array', @@ -57418,64 +32497,19 @@ 'description' => 'The details of the version.'."\n", 'type' => 'object', 'properties' => [ - 'LastPublishTime' => [ - 'description' => 'The time when the version was last released. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-02-10T02:48:36Z'."\n", - 'title' => '', - ], - 'PublishTime' => [ - 'description' => 'The time when the version was released. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-02-10T02:48:36Z', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the current version. Valid values:'."\n" - ."\n" - .'* **created**'."\n" - .'* **failed**'."\n" - .'* **creating**'."\n", - 'type' => 'string', - 'example' => 'created', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the version was created. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2022-11-10T02:53:16Z', - 'title' => '', - ], - 'AppId' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'example' => 'app-88068867578379****', - 'title' => '', - ], - 'VersionId' => [ - 'description' => 'The version ID.'."\n", - 'type' => 'string', - 'example' => 'ver-87962637161651****', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The version name.'."\n", - 'type' => 'string', - 'example' => 'version01', - 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'The time when the version was last modified. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-04-16 10:51:00', - 'title' => '', - ], - 'Remarks' => [ - 'description' => 'The remarks.'."\n", - 'type' => 'string', - 'example' => 'test version', - 'title' => '', - ], + 'LastPublishTime' => ['description' => 'The time when the version was last released. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2023-02-10T02:48:36Z'."\n", 'title' => ''], + 'PublishTime' => ['description' => 'The time when the version was released. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2023-02-10T02:48:36Z', 'title' => ''], + 'Status' => ['description' => 'The status of the current version. Valid values:'."\n" + ."\n" + .'* **created**'."\n" + .'* **failed**'."\n" + .'* **creating**'."\n", 'type' => 'string', 'example' => 'created', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the version was created. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2022-11-10T02:53:16Z', 'title' => ''], + 'AppId' => ['description' => 'The application ID.'."\n", 'type' => 'string', 'example' => 'app-88068867578379****', 'title' => ''], + 'VersionId' => ['description' => 'The version ID.'."\n", 'type' => 'string', 'example' => 'ver-87962637161651****', 'title' => ''], + 'Name' => ['description' => 'The version name.'."\n", 'type' => 'string', 'example' => 'version01', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the version was last modified. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2023-04-16 10:51:00', 'title' => ''], + 'Remarks' => ['description' => 'The remarks.'."\n", 'type' => 'string', 'example' => 'test version', 'title' => ''], 'Containers' => [ 'description' => 'The containers in the version.'."\n", 'type' => 'array', @@ -57483,138 +32517,32 @@ 'description' => 'The container in the version.'."\n", 'type' => 'object', 'properties' => [ - 'EnvVariables' => [ - 'description' => 'The environment variables of the container.'."\n", - 'type' => 'string', - 'example' => 'ENV=prod', - 'title' => '', - ], - 'Args' => [ - 'description' => 'The arguments that are passed to the container startup command.'."\n", - 'type' => 'string', - 'example' => '-c a=1', - 'title' => '', - ], - 'Spec' => [ - 'description' => 'The compute specification of the container.'."\n", - 'type' => 'string', - 'example' => '1C2G', - 'title' => '', - ], - 'Image' => [ - 'description' => 'The address of the container image.'."\n", - 'type' => 'string', - 'example' => 'nginx', - 'title' => '', - ], - 'Command' => [ - 'description' => 'The command that is used to start the container.'."\n", - 'type' => 'string', - 'example' => 'openresty -g \\"daemon off;\\"', - 'title' => '', - ], - 'ProbeType' => [ - 'description' => 'The probe type of the container.'."\n", - 'type' => 'string', - 'example' => 'httpGet', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The container name.'."\n", - 'type' => 'string', - 'example' => 'container1', - 'title' => '', - ], - 'PreStop' => [ - 'description' => 'The command that is run before the container is stopped.'."\n", - 'type' => 'string', - 'example' => 'sh prestop.sh "echo hello world" ', - 'title' => '', - ], - 'PostStart' => [ - 'description' => 'The command that is run before the container is started. Format: `{"exec":{"command":\\["cat","/etc/group"\\]}}`.'."\n" - ."\n" - .'If you want to cancel this configuration, set the parameter value to `""` or `{}`. If you do not specify this parameter, this configuration is ignored.'."\n", - 'type' => 'string', - 'example' => 'sh poststart.sh "echo hello world" ', - 'title' => '', - ], + 'EnvVariables' => ['description' => 'The environment variables of the container.'."\n", 'type' => 'string', 'example' => 'ENV=prod', 'title' => ''], + 'Args' => ['description' => 'The arguments that are passed to the container startup command.'."\n", 'type' => 'string', 'example' => '-c a=1', 'title' => ''], + 'Spec' => ['description' => 'The compute specification of the container.'."\n", 'type' => 'string', 'example' => '1C2G', 'title' => ''], + 'Image' => ['description' => 'The address of the container image.'."\n", 'type' => 'string', 'example' => 'nginx', 'title' => ''], + 'Command' => ['description' => 'The command that is used to start the container.'."\n", 'type' => 'string', 'example' => 'openresty -g \\"daemon off;\\"', 'title' => ''], + 'ProbeType' => ['description' => 'The probe type of the container.'."\n", 'type' => 'string', 'example' => 'httpGet', 'title' => ''], + 'Name' => ['description' => 'The container name.'."\n", 'type' => 'string', 'example' => 'container1', 'title' => ''], + 'PreStop' => ['description' => 'The command that is run before the container is stopped.'."\n", 'type' => 'string', 'example' => 'sh prestop.sh "echo hello world" ', 'title' => ''], + 'PostStart' => ['description' => 'The command that is run before the container is started. Format: `{"exec":{"command":\\["cat","/etc/group"\\]}}`.'."\n" + ."\n" + .'If you want to cancel this configuration, set the parameter value to `""` or `{}`. If you do not specify this parameter, this configuration is ignored.'."\n", 'type' => 'string', 'example' => 'sh poststart.sh "echo hello world" ', 'title' => ''], 'ProbeContent' => [ 'description' => 'The container probe content.'."\n", 'type' => 'object', 'properties' => [ - 'SuccessThreshold' => [ - 'description' => 'The number of consecutive successful health checks required for a container to be considered as healthy.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Host' => [ - 'description' => 'The domain name that is used for health checks.'."\n", - 'type' => 'string', - 'example' => 'test.com', - 'title' => '', - ], - 'HttpHeaders' => [ - 'description' => 'The request headers that are included in the container health check request.'."\n", - 'type' => 'string', - 'example' => '{\\"Content-Type\\":\\"application/json\\"}', - 'title' => '', - ], - 'Scheme' => [ - 'description' => 'The protocol that the container health check request uses.'."\n", - 'type' => 'string', - 'example' => 'http', - 'title' => '', - ], - 'InitialDelaySeconds' => [ - 'description' => 'The latency for container probe initialization.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'Command' => [ - 'description' => 'The probe command.'."\n", - 'type' => 'string', - 'example' => 'openresty -g "daemon off;', - 'title' => '', - ], - 'FailureThreshold' => [ - 'description' => 'The number of consecutive failed health checks required for a container to be considered as unhealthy.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'title' => '', - ], - 'TimeoutSeconds' => [ - 'description' => 'The timeout period of the container health check.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - 'title' => '', - ], - 'Path' => [ - 'description' => 'The path of the container health check.'."\n", - 'type' => 'string', - 'example' => '/health_check', - 'title' => '', - ], - 'Port' => [ - 'description' => 'The port of the container health check.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - 'title' => '', - ], - 'PeriodSeconds' => [ - 'description' => 'The interval between container health checks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'title' => '', - ], + 'SuccessThreshold' => ['description' => 'The number of consecutive successful health checks required for a container to be considered as healthy.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Host' => ['description' => 'The domain name that is used for health checks.'."\n", 'type' => 'string', 'example' => 'test.com', 'title' => ''], + 'HttpHeaders' => ['description' => 'The request headers that are included in the container health check request.'."\n", 'type' => 'string', 'example' => '{\\"Content-Type\\":\\"application/json\\"}', 'title' => ''], + 'Scheme' => ['description' => 'The protocol that the container health check request uses.'."\n", 'type' => 'string', 'example' => 'http', 'title' => ''], + 'InitialDelaySeconds' => ['description' => 'The latency for container probe initialization.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Command' => ['description' => 'The probe command.'."\n", 'type' => 'string', 'example' => 'openresty -g "daemon off;', 'title' => ''], + 'FailureThreshold' => ['description' => 'The number of consecutive failed health checks required for a container to be considered as unhealthy.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'TimeoutSeconds' => ['description' => 'The timeout period of the container health check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'Path' => ['description' => 'The path of the container health check.'."\n", 'type' => 'string', 'example' => '/health_check', 'title' => ''], + 'Port' => ['description' => 'The port of the container health check.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'PeriodSeconds' => ['description' => 'The interval between container health checks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], ], 'title' => '', 'example' => '', @@ -57643,63 +32571,27 @@ ], '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' => 'The OrderType parameter is invalid. Please check the OrderType parameter. You may not have set it to Asc or Desc. Please modify it and call the interface again.', - ], - [ - 'errorCode' => 'InvalidParameter.OrderKey', - 'errorMessage' => 'The specified OrderKey is invalid. Please check the OrderKey parameter.', - 'description' => 'The OrderKey parameter is invalid. Please check the OrderKey parameter, as it cannot be assigned illegal characters such as @, #, % etc. Please make the necessary modifications and call the interface again.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', - 'description' => 'Invalid parameter. Check the parameter configuration.', - ], - [ - 'errorCode' => 'InvalidParameter.appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application 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' => 'The request PageSize value is invalid. The default value is 20 and the value range is 1-500.', - ], + ['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' => 'The OrderType parameter is invalid. Please check the OrderType parameter. You may not have set it to Asc or Desc. Please modify it and call the interface again.'], + ['errorCode' => 'InvalidParameter.OrderKey', 'errorMessage' => 'The specified OrderKey is invalid. Please check the OrderKey parameter.', 'description' => 'The OrderKey parameter is invalid. Please check the OrderKey parameter, as it cannot be assigned illegal characters such as @, #, % etc. Please make the necessary modifications and call the interface again.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', 'description' => 'Invalid parameter. Check the parameter configuration.'], + ['errorCode' => 'InvalidParameter.appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application 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' => 'The request PageSize value is invalid. The default value is 20 and the value range is 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' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], '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"}]', 'title' => 'ListEdgeContainerAppVersions', 'changeSet' => [ - [ - 'createdAt' => '2024-11-12T02:06:26.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2024-11-12T02:06:26.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListEdgeContainerAppVersions', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEdgeContainerAppVersions'], ], ], 'ramActions' => [ @@ -57710,12 +32602,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -57723,14 +32610,8 @@ ], 'ListEdgeContainerApps' => [ 'summary' => 'Queries all containerized applications in your Alibaba Cloud account.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -57742,91 +32623,49 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239248', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: **1**. Valid values: 1 to 65535.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number. Default value: **1**. Valid values: 1 to 65535.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: **20**. Valid values: 1 to 500.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: **20**. Valid values: 1 to 500.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'OrderKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The sorting field. This parameter is left empty by default. Valid values:'."\n" - ."\n" - .'* Name: the version name.'."\n" - .'* CreateTime: the time when the version was created.'."\n" - .'* UpdateTime: the time when the version was last modified.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CreateTime', - 'default' => 'CreateTime', - 'title' => '', - ], + 'schema' => ['description' => 'The sorting field. This parameter is left empty by default. Valid values:'."\n" + ."\n" + .'* Name: the version name.'."\n" + .'* CreateTime: the time when the version was created.'."\n" + .'* UpdateTime: the time when the version was last modified.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CreateTime', 'default' => 'CreateTime', 'title' => ''], ], [ 'name' => 'OrderType', 'in' => 'query', - 'schema' => [ - 'description' => 'The order in which you want to sort the query results. This parameter is left empty by default. Valid values:'."\n" - ."\n" - .'* ASC: in ascending order.'."\n" - .'* DESC: in descending order.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Asc'."\n", - 'default' => 'Desc', - 'title' => '', - ], + 'schema' => ['description' => 'The order in which you want to sort the query results. This parameter is left empty by default. Valid values:'."\n" + ."\n" + .'* ASC: in ascending order.'."\n" + .'* DESC: in descending order.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Asc'."\n", 'default' => 'Desc', 'title' => ''], ], [ 'name' => 'SearchType', 'in' => 'query', - 'schema' => [ - 'description' => 'The search criterion based on which you want to perform fuzzy search. Valid values:'."\n" - ."\n" - .'* Appid: the application ID.'."\n" - .'* Name: the application name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AppId', - 'title' => '', - ], + 'schema' => ['description' => 'The search criterion based on which you want to perform fuzzy search. Valid values:'."\n" + ."\n" + .'* Appid: the application ID.'."\n" + .'* Name: the application name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'AppId', 'title' => ''], ], [ 'name' => 'SearchKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The search keyword.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ver-1005682639679266816', - 'title' => '', - ], + 'schema' => ['description' => 'The search keyword.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ver-1005682639679266816', 'title' => ''], ], ], 'responses' => [ @@ -57834,33 +32673,10 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2430E05E-1340-5773-B5E1-B743929F46F2', - 'title' => '', - ], - 'PageNumber' => [ - 'description' => 'The page number. Default value: **1**. Valid values: 1 to 65535.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 500.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2430E05E-1340-5773-B5E1-B743929F46F2', 'title' => ''], + 'PageNumber' => ['description' => 'The page number. Default value: **1**. Valid values: 1 to 65535.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Valid values: 1 to 500.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Apps' => [ 'description' => 'The queried applications.'."\n", 'type' => 'array', @@ -57868,171 +32684,47 @@ 'description' => 'The queried application.'."\n", 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the application. Valid values:'."\n" - ."\n" - .'* creating: The application is being created.'."\n" - .'* failed: The application failed to be created.'."\n" - .'* created: The application is created.'."\n", - 'type' => 'string', - 'example' => 'created', - 'title' => '', - ], - 'GatewayType' => [ - 'description' => 'The type of the gateway. Valid values:'."\n" - ."\n" - .'* l7: Layer 7 gateway.'."\n" - .'* l4: Layer 4 gateway.'."\n", - 'type' => 'string', - 'example' => 'l7', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the version was created.'."\n", - 'type' => 'string', - 'example' => '2022-12-01T16:16:27.418298794+08:00', - 'title' => '', - ], - 'VersionCount' => [ - 'description' => 'The number of versions of the application.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'DomainName' => [ - 'description' => 'The domain name associated with the application.'."\n", - 'type' => 'string', - 'example' => 'test.com', - 'title' => '', - ], - 'Remarks' => [ - 'description' => 'The remarks.'."\n", - 'type' => 'string', - 'example' => 'test app', - 'title' => '', - ], - 'ServicePort' => [ - 'description' => 'The server port. Valid values: 1 to 65535.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - 'title' => '', - ], - 'AppId' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'example' => 'app-88068867578379****', - 'title' => '', - ], - 'TargetPort' => [ - 'description' => 'The backend port, which is also the service port of the application. Valid values: 1 to 65535.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - 'title' => '', - ], - 'QuicCid' => [ - 'description' => 'Indicates whether QUIC is enabled.'."\n", - 'type' => 'string', - 'example' => 'false', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'example' => 'app-test', - 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'The time when the application was last modified. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-11-15T12:11:02Z', - 'title' => '', - ], + 'Status' => ['description' => 'The status of the application. Valid values:'."\n" + ."\n" + .'* creating: The application is being created.'."\n" + .'* failed: The application failed to be created.'."\n" + .'* created: The application is created.'."\n", 'type' => 'string', 'example' => 'created', 'title' => ''], + 'GatewayType' => ['description' => 'The type of the gateway. Valid values:'."\n" + ."\n" + .'* l7: Layer 7 gateway.'."\n" + .'* l4: Layer 4 gateway.'."\n", 'type' => 'string', 'example' => 'l7', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the version was created.'."\n", 'type' => 'string', 'example' => '2022-12-01T16:16:27.418298794+08:00', 'title' => ''], + 'VersionCount' => ['description' => 'The number of versions of the application.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'DomainName' => ['description' => 'The domain name associated with the application.'."\n", 'type' => 'string', 'example' => 'test.com', 'title' => ''], + 'Remarks' => ['description' => 'The remarks.'."\n", 'type' => 'string', 'example' => 'test app', 'title' => ''], + 'ServicePort' => ['description' => 'The server port. Valid values: 1 to 65535.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'AppId' => ['description' => 'The application ID.'."\n", 'type' => 'string', 'example' => 'app-88068867578379****', 'title' => ''], + 'TargetPort' => ['description' => 'The backend port, which is also the service port of the application. Valid values: 1 to 65535.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'QuicCid' => ['description' => 'Indicates whether QUIC is enabled.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], + 'Name' => ['description' => 'The application name.'."\n", 'type' => 'string', 'example' => 'app-test', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the application was last modified. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2023-11-15T12:11:02Z', 'title' => ''], 'HealthCheck' => [ 'description' => 'The information about health checks.'."\n", 'type' => 'object', 'properties' => [ - 'Timeout' => [ - 'description' => 'The timeout period of health checks. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The type of health checks. Valid values:'."\n" - ."\n" - .'* l7'."\n" - .'* l4'."\n", - 'type' => 'string', - 'example' => 'l7', - 'title' => '', - ], - 'Host' => [ - 'description' => 'The domain name that is used for health checks.'."\n", - 'type' => 'string', - 'example' => 'test.com', - 'title' => '', - ], - 'Interval' => [ - 'description' => 'The interval between health checks. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'title' => '', - ], - 'SuccTimes' => [ - 'description' => 'The number of consecutive successful health checks for an application to be considered healthy.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Method' => [ - 'description' => 'The HTTP method used for health checks.'."\n", - 'type' => 'string', - 'example' => 'GET', - 'title' => '', - ], - 'HttpCode' => [ - 'description' => 'The range of health check status codes that indicate successful health checks.'."\n", - 'type' => 'string', - 'example' => 'http_2XX', - 'title' => '', - ], - 'FailTimes' => [ - 'description' => 'The number of consecutive failed health checks for an application to be considered unhealthy.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'title' => '', - ], - 'Port' => [ - 'description' => 'The health check port.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8080', - 'title' => '', - ], - 'Uri' => [ - 'description' => 'The health check URL.'."\n", - 'type' => 'string', - 'example' => '/health_check', - 'title' => '', - ], + 'Timeout' => ['description' => 'The timeout period of health checks. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'Type' => ['description' => 'The type of health checks. Valid values:'."\n" + ."\n" + .'* l7'."\n" + .'* l4'."\n", 'type' => 'string', 'example' => 'l7', 'title' => ''], + 'Host' => ['description' => 'The domain name that is used for health checks.'."\n", 'type' => 'string', 'example' => 'test.com', 'title' => ''], + 'Interval' => ['description' => 'The interval between health checks. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'SuccTimes' => ['description' => 'The number of consecutive successful health checks for an application to be considered healthy.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Method' => ['description' => 'The HTTP method used for health checks.'."\n", 'type' => 'string', 'example' => 'GET', 'title' => ''], + 'HttpCode' => ['description' => 'The range of health check status codes that indicate successful health checks.'."\n", 'type' => 'string', 'example' => 'http_2XX', 'title' => ''], + 'FailTimes' => ['description' => 'The number of consecutive failed health checks for an application to be considered unhealthy.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'Port' => ['description' => 'The health check port.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8080', 'title' => ''], + 'Uri' => ['description' => 'The health check URL.'."\n", 'type' => 'string', 'example' => '/health_check', 'title' => ''], ], 'title' => '', 'example' => '', ], - 'Percentage' => [ - 'description' => 'The progress of the application creation task in percentage.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - 'title' => '', - ], + 'Percentage' => ['description' => 'The progress of the application creation task in percentage.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', @@ -58049,68 +32741,28 @@ ], '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' => 'The OrderType parameter is invalid. Please check the OrderType parameter. You may not have set it to Asc or Desc. Please modify it and call the interface again.', - ], - [ - 'errorCode' => 'InvalidParameter.OrderKey', - 'errorMessage' => 'The specified OrderKey is invalid. Please check the OrderKey parameter.', - 'description' => 'The OrderKey parameter is invalid. Please check the OrderKey parameter, as it cannot be assigned illegal characters such as @, #, % etc. Please make the necessary modifications and call the interface again.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', - 'description' => 'Invalid parameter. Check the parameter configuration.', - ], - [ - 'errorCode' => 'InvalidParameter.PageNumber', - 'errorMessage' => 'Failed to verify parameter PageNumber.Check whether the parameter exists and is set to a positive integer.', - 'description' => 'Failed to verify parameter PageNumber.Check whether the parameter exists and is set to a positive integer.', - ], - [ - 'errorCode' => 'InvalidParameter.appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application 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' => 'The request PageSize value is invalid. The default value is 20 and the value range is 1-500.', - ], + ['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' => 'The OrderType parameter is invalid. Please check the OrderType parameter. You may not have set it to Asc or Desc. Please modify it and call the interface again.'], + ['errorCode' => 'InvalidParameter.OrderKey', 'errorMessage' => 'The specified OrderKey is invalid. Please check the OrderKey parameter.', 'description' => 'The OrderKey parameter is invalid. Please check the OrderKey parameter, as it cannot be assigned illegal characters such as @, #, % etc. Please make the necessary modifications and call the interface again.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', 'description' => 'Invalid parameter. Check the parameter configuration.'], + ['errorCode' => 'InvalidParameter.PageNumber', 'errorMessage' => 'Failed to verify parameter PageNumber.Check whether the parameter exists and is set to a positive integer.', 'description' => 'Failed to verify parameter PageNumber.Check whether the parameter exists and is set to a positive integer.'], + ['errorCode' => 'InvalidParameter.appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application 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' => 'The request PageSize value is invalid. The default value is 20 and the value range is 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' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], '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"}]', 'title' => 'ListEdgeContainerApps', 'changeSet' => [ - [ - 'createdAt' => '2024-10-15T03:49:16.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-10-15T03:49:16.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListEdgeContainerApps', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEdgeContainerApps'], ], ], 'ramActions' => [ @@ -58121,12 +32773,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -58134,12 +32781,8 @@ ], 'ListEdgeContainerRecords' => [ 'summary' => 'Queries the records that are associated with Edge Container for a website.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -58152,73 +32795,38 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239659', - 'abilityTreeNodes' => [ - 'FEATUREdcdnVFT29S', - ], + 'abilityTreeNodes' => ['FEATUREdcdnVFT29S'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID. You can call the [ListSites](~~2850189~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID. You can call the [ListSites](~~2850189~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'RecordName', 'in' => 'query', - 'schema' => [ - 'description' => 'The record name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a.example.com', - 'title' => '', - ], + 'schema' => ['description' => 'The record name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'a.example.com', 'title' => ''], ], [ 'name' => 'RecordMatchType', 'in' => 'query', - 'schema' => [ - 'description' => 'The match mode to filter the record names:'."\n" - ."\n" - .'* **fuzzy**'."\n" - .'* **prefix**'."\n" - .'* **suffix**'."\n" - .'* **exact** (default)'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'fuzzy', - 'title' => '', - ], + 'schema' => ['description' => 'The match mode to filter the record names:'."\n" + ."\n" + .'* **fuzzy**'."\n" + .'* **prefix**'."\n" + .'* **suffix**'."\n" + .'* **exact** (default)'."\n", 'type' => 'string', 'required' => false, 'example' => 'fuzzy', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number. Default value: **1**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: **500**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: **500**.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ @@ -58226,33 +32834,10 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n", - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of records returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n"], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], 'Records' => [ 'description' => 'The records.'."\n", 'type' => 'array', @@ -58260,43 +32845,12 @@ 'description' => 'The queried record.'."\n", 'type' => 'object', 'properties' => [ - 'CreateTime' => [ - 'description' => 'The time when the record was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-12-24T02:01:11Z', - 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'The time when the record was updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2021-12-22T08:32:02Z', - 'title' => '', - ], - 'RecordName' => [ - 'description' => 'The record name.'."\n", - 'type' => 'string', - 'example' => 'a.example.com', - 'title' => '', - ], - 'RecordCname' => [ - 'description' => 'The CNAME. If you use CNAME setup when you add your website to ESA, the value is the CNAME that you configured.'."\n", - 'type' => 'string', - 'example' => 'a.example.com.cnamezone.com', - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567890123', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com', - 'title' => '', - ], + 'CreateTime' => ['description' => 'The time when the record was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2023-12-24T02:01:11Z', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the record was updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2021-12-22T08:32:02Z', 'title' => ''], + 'RecordName' => ['description' => 'The record name.'."\n", 'type' => 'string', 'example' => 'a.example.com', 'title' => ''], + 'RecordCname' => ['description' => 'The CNAME. If you use CNAME setup when you add your website to ESA, the value is the CNAME that you configured.'."\n", 'type' => 'string', 'example' => 'a.example.com.cnamezone.com', 'title' => ''], + 'SiteId' => ['description' => 'The website ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''], + 'SiteName' => ['description' => 'The website name.'."\n", 'type' => 'string', 'example' => 'example.com', 'title' => ''], ], 'title' => '', 'example' => '', @@ -58313,32 +32867,18 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'ListEdgeContainerRecords', 'changeSet' => [ - [ - 'createdAt' => '2024-09-18T06:56:37.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-18T06:56:37.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListEdgeContainerRecords', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEdgeContainerRecords'], ], ], 'ramActions' => [ @@ -58349,12 +32889,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -58366,12 +32901,8 @@ ], 'ListEdgeRoutinePlans' => [ 'summary' => 'Queries Edge Routine plans.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -58384,9 +32915,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238723', - 'abilityTreeNodes' => [ - 'FEATUREdcdnZA9EPX', - ], + 'abilityTreeNodes' => ['FEATUREdcdnZA9EPX'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [], @@ -58397,12 +32926,7 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9'], 'PlanInfo' => [ 'description' => 'The plans.'."\n", 'type' => 'array', @@ -58410,48 +32934,18 @@ 'description' => 'The details of the plan.'."\n", 'type' => 'object', 'properties' => [ - 'PlanName' => [ - 'description' => 'The plan name.'."\n", - 'type' => 'string', - 'example' => 'test_plan', - 'title' => '', - ], - 'ErRoutineQuota' => [ - 'description' => 'The maximum of routines that can be created.'."\n", - 'type' => 'string', - 'example' => '100', - 'title' => '', - ], - 'ErRoutineCodeVersionQuota' => [ - 'description' => 'The maximum number of versions that each routine supports.'."\n", - 'type' => 'string', - 'example' => '20', - 'title' => '', - ], - 'ErRoutineRouteSiteCountQuota' => [ - 'description' => 'The maximum number of websites with which each routine can be associated.'."\n", - 'type' => 'string', - 'example' => '100', - 'title' => '', - ], - 'BillingMode' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* PREPAY: subscription.'."\n" - .'* POSTPAY: pay-as-you-go.'."\n", - 'type' => 'string', - 'example' => 'POSTPAY', - 'title' => '', - ], - 'PaymentMethod' => [ - 'description' => 'The payment method. Valid values:'."\n" - ."\n" - .'* er_free'."\n" - .'* er_pay'."\n", - 'type' => 'string', - 'example' => 'er_free', - 'title' => '', - ], + 'PlanName' => ['description' => 'The plan name.'."\n", 'type' => 'string', 'example' => 'test_plan', 'title' => ''], + 'ErRoutineQuota' => ['description' => 'The maximum of routines that can be created.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''], + 'ErRoutineCodeVersionQuota' => ['description' => 'The maximum number of versions that each routine supports.'."\n", 'type' => 'string', 'example' => '20', 'title' => ''], + 'ErRoutineRouteSiteCountQuota' => ['description' => 'The maximum number of websites with which each routine can be associated.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''], + 'BillingMode' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* PREPAY: subscription.'."\n" + .'* POSTPAY: pay-as-you-go.'."\n", 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''], + 'PaymentMethod' => ['description' => 'The payment method. Valid values:'."\n" + ."\n" + .'* er_free'."\n" + .'* er_pay'."\n", 'type' => 'string', 'example' => 'er_free', 'title' => ''], ], 'title' => '', 'example' => '', @@ -58459,34 +32953,10 @@ 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 500.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - 'title' => '', - ], - 'TotalPage' => [ - 'description' => 'The total number of pages returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], + 'PageNumber' => ['description' => 'The page number. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Valid values: 1 to 500.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'example' => '', ], @@ -58494,32 +32964,17 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'ListEdgeRoutinePlans', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListEdgeRoutinePlans', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEdgeRoutinePlans'], ], ], 'ramActions' => [ @@ -58530,25 +32985,16 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListEdgeRoutineRecords' => [ - 'summary' => 'Queries the records that are associated with Edge Routine routes for a website.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the list of edge routing records for a site.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -58561,73 +33007,37 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239603', - 'abilityTreeNodes' => [ - 'FEATUREdcdnVFT29S', - ], + 'abilityTreeNodes' => ['FEATUREdcdnVFT29S'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID. You can call the [ListSites](~~2850189~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'RecordName', 'in' => 'query', - 'schema' => [ - 'description' => 'The record name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a.example.com', - 'title' => '', - ], + 'schema' => ['description' => 'Filters by the specified record name.', 'type' => 'string', 'required' => false, 'example' => 'a.example.com', 'title' => ''], ], [ 'name' => 'RecordMatchType', 'in' => 'query', - 'schema' => [ - 'description' => 'The match mode to filter the record names.'."\n" - ."\n" - .'* **fuzzy**: fuzzy match.'."\n" - .'* **prefix**: match by prefix.'."\n" - .'* **suffix**: match by suffix.'."\n" - .'* **exact** (default): exact match .'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'fuzzy', - 'title' => '', - ], + 'schema' => ['description' => 'The matching mode used to filter by record name. Valid values:'."\n" + .'- **fuzzy**: fuzzy match.'."\n" + .'- **prefix**: prefix match.'."\n" + .'- **suffix**: suffix match.'."\n" + .'- **exact**: exact match (default).', 'type' => 'string', 'required' => false, 'example' => 'fuzzy', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number for a paged query. The value must be greater than or equal to 1. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: **500**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - 'title' => '', - ], + 'schema' => ['description' => 'The number of records per page for a paged query. Valid values: 1 to 500. Default value: **500**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ @@ -58635,77 +33045,23 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', - ], - 'PageNumber' => [ - 'description' => 'The total number of pages returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of records returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '121', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'], + 'PageNumber' => ['description' => 'The current page number, which is the same as the PageNumber request parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of records displayed per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '121', 'title' => ''], 'Records' => [ - 'description' => 'The list of records.'."\n", + 'description' => 'The list of records.', 'type' => 'array', 'items' => [ - 'description' => 'The information about a single record.'."\n", + 'description' => 'The information about a single record.', 'type' => 'object', 'properties' => [ - 'CreateTime' => [ - 'description' => 'The time when the record was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-12-24T02:01:11Z', - 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'The time when the record was updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-12-22T08:32:02Z', - 'title' => '', - ], - 'RecordName' => [ - 'description' => 'The record name.'."\n", - 'type' => 'string', - 'example' => 'a.example.com', - 'title' => '', - ], - 'RecordCname' => [ - 'description' => 'The CNAME. If you use CNAME setup when you add your website to ESA, the value is the CNAME that you configured then.'."\n", - 'type' => 'string', - 'example' => 'a.example.com.cnamezone.com', - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5407498413****', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com', - 'title' => '', - ], + 'CreateTime' => ['description' => 'The creation time of the record. The time is in ISO 8601 format and displayed in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2023-12-24T02:01:11Z', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time of the record. The time is in ISO 8601 format and displayed in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2023-12-22T08:32:02Z', 'title' => ''], + 'RecordName' => ['description' => 'The record name.', 'type' => 'string', 'example' => 'a.example.com', 'title' => ''], + 'RecordCname' => ['description' => 'The CNAME of the record. When the site uses CNAME access, this is the CNAME value that needs to be configured for the record.', 'type' => 'string', 'example' => 'a.example.com.cnamezone.com', 'title' => ''], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '5407498413****', 'title' => ''], + 'SiteName' => ['description' => 'The name of the site to which the record belongs.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], ], 'title' => '', 'example' => '', @@ -58722,33 +33078,23 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], '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"}]', - 'title' => 'ListEdgeRoutineRecords', - 'description' => '> You can call this operation 100 times per second.'."\n", + 'title' => 'Query edge routing records', + 'description' => '> API call frequency: 100 calls per second.', 'changeSet' => [ - [ - 'createdAt' => '2024-09-18T06:56:37.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-18T06:56:37.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListEdgeRoutineRecords', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEdgeRoutineRecords'], ], ], 'ramActions' => [ @@ -58759,247 +33105,123 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], ], 'ListHttpIncomingRequestHeaderModificationRules' => [ - 'summary' => 'Queries the configuration details of an incoming HTTP request header modification rule for a website.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the list of HTTP incoming request header modification configurations for a site.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257649', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '608665779308176', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '608665779308176', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration ID. You can call the ListHttpIncomingRequestHeaderModificationRules operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '424371770570752', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID. You can call the ListHttpIncomingRequestHeaderModificationRules operation to obtain the configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '424371770570752', 'title' => ''], ], [ 'name' => 'ConfigType', 'in' => 'query', 'schema' => [ 'title' => '', - 'description' => 'The configuration type to query. Valid values:'."\n" + 'description' => 'The configuration type. You can use this parameter to query global or rule configurations. Valid values:'."\n" ."\n" - .'* global: global configurations.'."\n" - .'* rule: rule configurations.'."\n", + .'- global: queries global configurations.'."\n" + .'- rule: queries rule configurations.', + 'enumValueTitles' => ['rule' => 'rule configuration.', 'global' => 'global configuration.'], 'type' => 'string', + 'enum' => ['global', 'rule'], 'required' => false, - 'enum' => [ - 'global', - 'rule', - ], 'example' => 'rule', ], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The rule name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - ], + 'schema' => ['title' => '', 'description' => 'The rule name.', 'type' => 'string', 'required' => false, 'example' => 'rule_example'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number for a paged query. The value must be greater than or equal to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The number of entries per page. Maximum value: 500. Default value: 500.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page for a paged query. Valid values: 1 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. The default value is version 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7FB6EBC8-8849-5FC6-890E-3A761A5CD42D', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7FB6EBC8-8849-5FC6-890E-3A761A5CD42D'], 'Configs' => [ - 'description' => 'The configuration list of the incoming HTTP request header modification.'."\n", + 'description' => 'The list of HTTP incoming request header modification configurations.', 'type' => 'array', 'items' => [ - 'description' => 'The configurations of the incoming HTTP request header modification.'."\n", + 'description' => 'The details of an HTTP incoming request header modification configuration.', 'type' => 'object', 'properties' => [ - 'ConfigId' => [ - 'description' => 'The configuration ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '429422870243328', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'The order in which the rule is executed. A smaller value gives priority to the rule.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:'."\n" - ."\n" - .'* true: Match all incoming requests.'."\n" - .'* Set the value to a custom expression, for example, (http.host eq "video.example.com"): Match the specified request.'."\n", - 'type' => 'string', - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'The rule name. You do not need to set this parameter when you add global configuration.'."\n", - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'The type of the configuration. Valid values:'."\n" - ."\n" - .'* global: global configurations.'."\n" - .'* rule: rule configurations.'."\n", - 'type' => 'string', - 'example' => 'rule', - 'title' => '', - ], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '429422870243328', 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. The default value is version 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Sequence' => ['description' => 'The execution order of the rule. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Rule' => ['description' => 'The rule content, which uses a conditional expression to match user requests. This parameter does not need to be set when adding a global configuration. Two usage scenarios exist:'."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + .'- Match specified requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\").', 'type' => 'string', 'example' => '(http.host eq "video.example.com")', 'title' => ''], + 'RuleEnable' => ['description' => 'The rule switch. This parameter does not need to be set when adding a global configuration. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'RuleName' => ['description' => 'The rule name. This parameter does not need to be set when adding a global configuration.', 'type' => 'string', 'example' => 'rule_example', 'title' => ''], + 'ConfigType' => ['description' => 'The configuration type. Valid values:'."\n" + .'- global: global configuration.'."\n" + .'- rule: rule configuration.', 'type' => 'string', 'example' => 'rule', 'title' => ''], 'RequestHeaderModification' => [ - 'description' => 'The configurations of modifying request headers. You can add, delete, or modify a request header.'."\n", + 'description' => 'The request header modifications, which support add, delete, and modify operations.', 'type' => 'array', 'items' => [ - 'description' => 'The configuration of modifying a request header.'."\n", + 'description' => 'The details of a request header modification.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the request header.'."\n", - 'type' => 'string', - 'example' => 'headerName', - 'title' => '', - ], - 'Operation' => [ - 'description' => 'The action. Valid values:'."\n" - ."\n" - .'* add: adds a response header.'."\n" - .'* del: deletes a response header.'."\n" - .'* modify: modifies a response header.'."\n", - 'type' => 'string', - 'example' => 'add', - 'title' => '', - ], - 'Value' => [ - 'description' => 'The value of the request header.'."\n", - 'type' => 'string', - 'example' => 'headerValue', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The type of the value. Valid values:'."\n" - ."\n" - .'* static'."\n" - .'* dynamic'."\n", - 'type' => 'string', - 'example' => 'static', - 'title' => '', - ], + 'Name' => ['description' => 'The request header name.', 'type' => 'string', 'example' => 'headerName', 'title' => ''], + 'Operation' => ['description' => 'The operation type. Valid values:'."\n" + ."\n" + .'- add: adds a header.'."\n" + .'- del: deletes a header.'."\n" + .'- modify: modifies a header.', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'Value' => ['description' => 'The request header value.', 'type' => 'string', 'example' => 'headerValue', 'title' => ''], + 'Type' => ['description' => 'The value type. Valid values:'."\n" + .'- static: static pattern.'."\n" + .'- dynamic: dynamic schema.', 'type' => 'string', 'example' => 'static', 'title' => ''], ], 'title' => '', 'example' => '', @@ -59014,34 +33236,10 @@ 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'description' => 'The number of the returned page. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 500. Valid values: 1 to 500.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'TotalPage' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], + 'PageNumber' => ['description' => 'The current page number, which is the same as the PageNumber request parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Default value: 500. Valid values: 1 to 500.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'example' => '', ], @@ -59049,23 +33247,17 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], ], ], '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"}]', - 'title' => 'ListHttpIncomingRequestHeaderModificationRules', + 'title' => 'Query HTTP incoming request header modification configurations', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHttpIncomingRequestHeaderModificationRules'], + ], ], 'ramActions' => [ [ @@ -59075,244 +33267,122 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'operationType' => 'read', ], 'ListHttpIncomingResponseHeaderModificationRules' => [ - 'summary' => 'Queries the configurations of an incoming HTTP response header modification rule for a website.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the list of configurations for modifying HTTP incoming response headers of a site.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257655', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '624516866852544', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can obtain this by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '624516866852544', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration ID. You can call the ListHttpIncomingResponseHeaderModificationRules operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '432915173664768', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID. You can obtain this by calling the ListHttpIncomingResponseHeaderModificationRules operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '432915173664768', 'title' => ''], ], [ 'name' => 'ConfigType', 'in' => 'query', 'schema' => [ 'title' => '', - 'description' => 'The configuration type to query. Valid values:'."\n" + 'description' => 'The configuration type. You can use this parameter to query global configurations or rule configurations. Valid values:'."\n" ."\n" - .'* global: global configurations.'."\n" - .'* rule: rule configurations.'."\n", + .'- global: queries global configurations.'."\n" + .'- rule: queries rule configurations.', + 'enumValueTitles' => ['rule' => 'rule configuration.', 'global' => 'global configuration.'], 'type' => 'string', + 'enum' => ['global', 'rule'], 'required' => false, - 'enum' => [ - 'global', - 'rule', - ], 'example' => 'rule', ], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The rule name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - ], + 'schema' => ['title' => '', 'description' => 'The rule name.', 'type' => 'string', 'required' => false, 'example' => 'rule_example'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number for a paged query. The value must be greater than or equal to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The number of entries per page. Maximum value: 500. Default value: 500.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page for a paged query. Valid values: 1 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. The default value is version 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CF02C6F6-DB59-5438-8C05-3CE42DFCB0AD', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CF02C6F6-DB59-5438-8C05-3CE42DFCB0AD'], 'Configs' => [ - 'description' => 'The list of incoming response header modification rules.'."\n", + 'description' => 'The list of configurations for modifying HTTP incoming response headers.', 'type' => 'array', 'items' => [ - 'description' => 'The content of the incoming response header modification rule.'."\n", + 'description' => 'The details of a configuration for modifying HTTP incoming response headers.', 'type' => 'object', 'properties' => [ - 'ConfigId' => [ - 'description' => 'The configuration ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '430559776208896', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'The order in which the rule is executed. A smaller value gives priority to the rule.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Specifies whether to check the image used by the instance supports hot migration. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:'."\n" - ."\n" - .'* true: Match all incoming requests.'."\n" - .'* Set the value to a custom expression, for example:(http.host eq "video.example.com"): Match the specified request.'."\n", - 'type' => 'string', - 'example' => '(http.host eq "video.example.com")'."\n", - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'The rule name. You do not need to set this parameter when you add global configuration.'."\n", - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'The type of the configuration. Specifies whether to check the image used by the instance supports hot migration. Valid values:'."\n" - ."\n" - .'* global: global configuration.'."\n" - .'* rule: rule configuration.'."\n", - 'type' => 'string', - 'example' => 'rule', - 'title' => '', - ], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '430559776208896', 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. The default value is version 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Sequence' => ['description' => 'The execution order of the rule. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuleEnable' => ['description' => 'The rule switch. This parameter does not need to be set when adding a global configuration. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'The rule content, which uses a conditional expression to match user requests. This parameter does not need to be set when adding a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: set the value to true.'."\n" + .'- Match specified requests: set the value to a custom expression, for example: (http.host eq \\"video.example.com\\").', 'type' => 'string', 'example' => '(http.host eq "video.example.com")'."\n", 'title' => ''], + 'RuleName' => ['description' => 'The rule name. This parameter does not need to be set when adding a global configuration.', 'type' => 'string', 'example' => 'rule_example', 'title' => ''], + 'ConfigType' => ['description' => 'The configuration type. Valid values:'."\n" + .'- global: global configuration.'."\n" + .'- rule: rule configuration.', 'type' => 'string', 'example' => 'rule', 'title' => ''], 'ResponseHeaderModification' => [ - 'description' => 'The configurations of modifying response headers. You can add, delete, or modify a response header.'."\n", + 'description' => 'The response header modifications. Three operations are supported: add, delete, and modify.', 'type' => 'array', 'items' => [ - 'description' => 'The configuration of modifying a response header.'."\n", + 'description' => 'The details of a response header modification.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the response header.'."\n", - 'type' => 'string', - 'example' => 'headerName', - 'title' => '', - ], - 'Operation' => [ - 'description' => 'The action. Specifies whether to check the image used by the instance supports hot migration. Valid values:'."\n" - ."\n" - .'* add: adds a response header.'."\n" - .'* del: deletes a response header.'."\n" - .'* modify: modifies a response header.'."\n", - 'type' => 'string', - 'example' => 'add', - 'title' => '', - ], - 'Value' => [ - 'description' => 'The value of the response header.'."\n", - 'type' => 'string', - 'example' => 'headerValue', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The type of the header. Valid values:'."\n" - ."\n" - .'* static'."\n" - .'* dynamic'."\n", - 'type' => 'string', - 'example' => 'static', - 'title' => '', - ], + 'Name' => ['description' => 'The response header name.', 'type' => 'string', 'example' => 'headerName', 'title' => ''], + 'Operation' => ['description' => 'The operation type. Valid values:'."\n" + .'- add: adds a response header.'."\n" + .'- del: deletes a response header.'."\n" + .'- modify: modifies a response header.', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'Value' => ['description' => 'The response header value.', 'type' => 'string', 'example' => 'headerValue', 'title' => ''], + 'Type' => ['description' => 'The value type. Valid values:'."\n" + .'- static: static pattern.'."\n" + .'- dynamic: dynamic schema.', 'type' => 'string', 'example' => 'static', 'title' => ''], ], 'title' => '', 'example' => '', @@ -59327,34 +33397,10 @@ 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'description' => 'The number of the returned page. Default value: 1'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 500. Valid values: 1 to 500.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'TotalPage' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], + 'PageNumber' => ['description' => 'The current page number, which is the same as the PageNumber request parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Default value: 500. Valid values: 1 to 500.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'example' => '', ], @@ -59362,52 +33408,36 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], ], ], '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"}]', - 'title' => 'ListHttpIncomingResponseHeaderModificationRules', + 'title' => 'Query configurations for modifying HTTP incoming response headers', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHttpIncomingResponseHeaderModificationRules'], + ], ], 'ramActions' => [ [ - 'operationType' => 'none', + 'operationType' => 'list', 'ramAction' => [ 'action' => 'esa:ListHttpIncomingResponseHeaderModificationRules', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'operationType' => 'read', ], 'ListHttpRequestHeaderModificationRules' => [ - 'summary' => 'List of HTTP Request Header Rules', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the list of HTTP request header modification configurations.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -59420,208 +33450,100 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257649', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****'."\n", 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID, which can be obtained by calling the [ListHttpRequestHeaderModificationRules](~~2867483~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID. You can call the [ListHttpRequestHeaderModificationRules](~~2867483~~) operation to obtain the configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '35281609698****', 'title' => ''], ], [ 'name' => 'ConfigType', 'in' => 'query', 'schema' => [ - 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', - 'description' => 'Configuration type, which can be used to query global or rule configurations. Possible values:'."\n" - .'- global: Query global configuration;'."\n" - .'- rule: Query rule configuration;', + 'title' => '', + 'description' => 'The configuration type. You can use this parameter to query global or rule configurations. Valid values:'."\n" + .'- global: queries global configurations.'."\n" + .'- rule: queries rule configurations.', + 'enumValueTitles' => ['rule' => 'rule configuration.', 'global' => 'global configuration.'], 'type' => 'string', + 'enum' => ['global', 'rule'], 'required' => false, 'example' => 'rule', - 'enum' => [ - 'global', - 'rule', - ], ], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - ], + 'schema' => ['title' => '', 'description' => 'The rule name. You do not need to set this parameter when adding a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '第几页，不传时默认为1', - 'description' => 'Page number, defaulting to 1 if not provided.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number for a paged query. The value must be greater than or equal to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '每页几条，最大500，不传时默认500', - 'description' => 'Number of items per page, with a maximum of 500. Defaults to 500 if not provided.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page for a paged query. Valid values: 1 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the effective version of the configuration, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. The default value is version 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Request response result.', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '35C66C7B-671H-4297-9187-2C4477247A78', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '35C66C7B-671H-4297-9187-2C4477247A78'], 'Configs' => [ - 'description' => 'List of HTTP request header modification configurations.', + 'description' => 'The list of HTTP request header modification configurations.', 'type' => 'array', 'items' => [ - 'description' => 'Details of HTTP request header modifications.', + 'description' => 'The details of the HTTP request header modification.', 'type' => 'object', 'properties' => [ - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '35281609698****'."\n", - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'Version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the effective version of the configuration, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'Rule execution order. The smaller the value, the higher the priority.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Possible values:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'Configuration type. Possible values:'."\n" - .'- global: Global configuration;'."\n" - .'- rule: Rule configuration;', - 'type' => 'string', - 'example' => 'global', - 'title' => '', - ], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '35281609698****'."\n", 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. The default value is version 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Sequence' => ['description' => 'The execution order of the rule. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Rule' => ['description' => 'The rule content, which uses conditional expressions to match user requests. You do not need to set this parameter when adding a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + .'- Match specified requests: Set the value to a custom expression, such as (http.host eq \\"video.example.com\\").', 'type' => 'string', 'example' => '(http.host eq "video.example.com")', 'title' => ''], + 'RuleEnable' => ['description' => 'The rule switch. You do not need to set this parameter when adding a global configuration. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'RuleName' => ['description' => 'The rule name. You do not need to set this parameter when adding a global configuration.', 'type' => 'string', 'example' => 'rule_example', 'title' => ''], + 'ConfigType' => ['description' => 'The configuration type. Valid values:'."\n" + .'- global: global configuration.'."\n" + .'- rule: rule configuration.', 'type' => 'string', 'example' => 'global', 'title' => ''], 'RequestHeaderModification' => [ - 'description' => 'Modify request headers, supporting add, delete, and modify operations.', + 'description' => 'The request header modifications, which support add, delete, and modify operations.', 'type' => 'array', 'items' => [ - 'description' => 'Details of request header modifications.', + 'description' => 'The details of the request header modification.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the request header.', - 'type' => 'string', - 'example' => 'headerName', - 'title' => '', - ], - 'Operation' => [ - 'description' => 'The operation type. The value range is as follows:'."\n" - ."\n" - .'- add: Add.'."\n" - .'- del: Delete.'."\n" - .'- modify: Modify.', - 'type' => 'string', - 'example' => 'add', - 'title' => '', - ], - 'Value' => [ - 'description' => 'The value of the request header.', - 'type' => 'string', - 'example' => 'headerValue', - 'title' => '', - ], - 'Type' => [ - 'description' => 'Value Type. Valid values:'."\n" - .'- static: Static pattern.'."\n" - .'- dynamic: Dynamic pattern.', - 'type' => 'string', - 'example' => 'static', - 'title' => '', - ], + 'Name' => ['description' => 'The request header name.', 'type' => 'string', 'example' => 'headerName', 'title' => ''], + 'Operation' => ['description' => 'The operation type. Valid values:'."\n" + ."\n" + .'- add: adds a header.'."\n" + .'- del: deletes a header.'."\n" + .'- modify: modifies a header.', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'Value' => ['description' => 'The request header value.', 'type' => 'string', 'example' => 'headerValue', 'title' => ''], + 'Type' => ['description' => 'The value type. Valid values:'."\n" + .'- static: static pattern.'."\n" + .'- dynamic: dynamic schema.', 'type' => 'string', 'example' => 'static', 'title' => ''], ], 'title' => '', 'example' => '', @@ -59636,34 +33558,10 @@ 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'description' => 'Page number. Default value: **1**.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'Page size, default **500**, with a range of **1~500**.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'Total number of items.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'TotalPage' => [ - 'description' => 'Total number of pages.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], + 'PageNumber' => ['description' => 'The current page number, which is the same as the PageNumber request parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Default value: **500**. Valid values: **1 to 500**.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'example' => '', ], @@ -59671,33 +33569,18 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], ], ], - 'title' => 'List of HTTP Request Header Modification Configurations', + '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"}]', + 'title' => 'Query HTTP request header modification configurations', 'changeSet' => [ - [ - 'createdAt' => '2025-04-10T07:02:38.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-04-10T07:02:38.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListHttpRequestHeaderModificationRules', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHttpRequestHeaderModificationRules'], ], ], 'ramActions' => [ @@ -59708,25 +33591,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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', - ], + 'summary' => 'Queries the list of HTTP response header modification configurations for a site.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -59739,209 +33613,101 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257655', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '35281609698****', 'title' => ''], ], [ 'name' => 'ConfigType', 'in' => 'query', 'schema' => [ - 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', - 'description' => 'Configuration type, which can be used to query global or rule configurations. Possible values:'."\n" - .'- global: Query global configuration.'."\n" - .'- rule: Query rule configuration.'."\n" + 'title' => '', + 'description' => 'The configuration type. You can use this parameter to query global or rule configurations. Valid values:'."\n" + .'- global: queries global configurations.'."\n" + .'- rule: queries rule configurations.'."\n" ."\n" - .'This parameter is optional. If not provided, it does not distinguish between global and rule configurations.', + .'This parameter is optional. If you do not specify this parameter, both global and rule configurations are returned.', + 'enumValueTitles' => ['rule' => 'rule configuration.', 'global' => 'global configuration.'], 'type' => 'string', + 'enum' => ['global', 'rule'], 'required' => false, 'example' => 'rule', - 'enum' => [ - 'global', - 'rule', - ], ], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - ], + 'schema' => ['title' => '', 'description' => 'The rule name. You do not need to set this parameter when you add a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '第几页，不传时默认为1', - 'description' => 'Page number.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number for a paged query. The value must be greater than or equal to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '每页几条，最大500，不传时默认500', - 'description' => 'Page size, default is 500. The value range is any integer from 1 to 500.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page for a paged query. Valid values: 1 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the effective version of the configuration, with the default being version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Request response result.', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE'], 'Configs' => [ - 'description' => 'List of modified HTTP response headers.', + 'description' => 'The list of HTTP response header modifications.', 'type' => 'array', 'items' => [ - 'description' => 'Details of the modified HTTP response header.', + 'description' => 'The details of an HTTP response header modification.', 'type' => 'object', 'properties' => [ - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '35281609698****'."\n", - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'Version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the effective version of the configuration, with the default being version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'Rule execution order. The smaller the value, the higher the priority.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Possible values:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'example' => '(http.host eq "video.example.com")'."\n", - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'Configuration type. Possible values:'."\n" - .'- global: Global configuration.'."\n" - .'- rule: Rule configuration.', - 'type' => 'string', - 'example' => 'rule', - 'title' => '', - ], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '35281609698****'."\n", 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Sequence' => ['description' => 'The execution order of the rule. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuleEnable' => ['description' => 'The rule switch. You do not need to set this parameter when you add a global configuration. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'The rule content, which uses a conditional expression to match user requests. You do not need to set this parameter when you add a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: set the value to true.'."\n" + .'- Match specific requests: set the value to a custom expression, for example, (http.host eq \\"video.example.com\\").', 'type' => 'string', 'example' => '(http.host eq "video.example.com")'."\n", 'title' => ''], + 'RuleName' => ['description' => 'The rule name. You do not need to set this parameter when you add a global configuration.', 'type' => 'string', 'example' => 'rule_example', 'title' => ''], + 'ConfigType' => ['description' => 'The configuration type. Valid values:'."\n" + .'- global: global configuration.'."\n" + .'- rule: rule configuration.', 'type' => 'string', 'example' => 'rule', 'title' => ''], 'ResponseHeaderModification' => [ - 'description' => 'Modify response headers, supporting add, delete, and modify operations.', + 'description' => 'The response header modifications. Three operations are supported: add, delete, and modify.', 'type' => 'array', 'items' => [ - 'description' => 'Response header details.', + 'description' => 'The details of a response header.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'Name of the response header.', - 'type' => 'string', - 'example' => 'headerName', - 'title' => '', - ], - 'Operation' => [ - 'description' => 'Operation type. The value range is as follows:'."\n" - .'- add: Add.'."\n" - .'- del: Delete'."\n" - .'- modify: Modify.', - 'type' => 'string', - 'example' => 'add', - 'title' => '', - ], - 'Value' => [ - 'description' => 'Response header value.', - 'type' => 'string', - 'example' => 'headerValue', - 'title' => '', - ], - 'Type' => [ - 'description' => 'Value Type. Valid values: '."\n" - .'- static: Static pattern. '."\n" - .'- dynamic: Dynamic pattern. ', - 'type' => 'string', - 'example' => 'static', - 'title' => '', - ], + 'Name' => ['description' => 'The response header name.', 'type' => 'string', 'example' => 'headerName', 'title' => ''], + 'Operation' => ['description' => 'The operation type. Valid values:'."\n" + .'- add: adds a response header.'."\n" + .'- del: deletes a response header.'."\n" + .'- modify: modifies a response header.', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'Value' => ['description' => 'The response header value.', 'type' => 'string', 'example' => 'headerValue', 'title' => ''], + 'Type' => ['description' => 'The value type. Valid values:'."\n" + .'- static: static pattern.'."\n" + .'- dynamic: dynamic schema.', 'type' => 'string', 'example' => 'static', 'title' => ''], ], 'title' => '', 'example' => '', @@ -59956,34 +33722,10 @@ 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'description' => 'Page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'Page size.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'Total count.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '14', - 'title' => '', - ], - 'TotalPage' => [ - 'description' => 'Total pages.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], + 'PageNumber' => ['description' => 'The current page number, which is the same as the PageNumber request parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '14', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'example' => '', ], @@ -59991,34 +33733,18 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], ], ], - 'title' => 'List of Configurations for Modifying HTTP Response Headers', - 'summary' => 'List of HTTP Response Header Rules', + '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"}]', + 'title' => 'Query HTTP response header modification configurations', 'changeSet' => [ - [ - 'createdAt' => '2025-04-10T07:02:39.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-04-10T07:02:39.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListHttpResponseHeaderModificationRules', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHttpResponseHeaderModificationRules'], ], ], 'ramActions' => [ @@ -60029,26 +33755,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => 'Query multiple HTTPS application configurations', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Query multiple HTTPS application configurations.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -60061,272 +33777,126 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257534', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID. You can obtain it by calling the [ListSites](~~ListSites~~) API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3528160969****', - 'title' => '', - ], + 'schema' => ['description' => 'Configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3528160969****', 'title' => ''], ], [ 'name' => 'ConfigType', 'in' => 'query', 'schema' => [ - 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', - 'description' => 'Configuration type, which can be used to query global or rule-based configurations. Possible values:'."\n" - .'- global: Query global configuration.'."\n" - .'- rule: Query rule-based configuration.'."\n" + 'title' => '', + 'description' => 'Configuration type. You can use this parameter to query global configurations or rule configurations. Valid values:'."\n" + .'- global: Query global configurations.'."\n" + .'- rule: Query rule configurations.'."\n" ."\n" - .'This parameter is optional. If not provided, it will not distinguish between global and rule-based configurations.', + .'This parameter is optional. If not specified, no distinction is made between global and rule configurations.', + 'enumValueTitles' => ['rule' => 'Rule configuration', 'global' => 'Global configuration'], 'type' => 'string', + 'enum' => ['global', 'rule'], 'required' => false, 'example' => 'global', - 'enum' => [ - 'global', - 'rule', - ], ], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', - 'description' => 'Rule name, which can be used to find the rule with the specified name.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - ], + 'schema' => ['title' => '', 'description' => 'Rule name. You can query the rule whose name matches the specified value.', 'type' => 'string', 'required' => false, 'example' => 'rule_example'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '第几页，不传时默认为1', - 'description' => 'Page number, default is 1 if not provided.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number for paginated queries. The value must be greater than or equal to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '每页几条，最大500，不传时默认500', - 'description' => 'Number of items per page, maximum is 500, default is 500 if not provided.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page for paginated queries. Valid values: 1-500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Site version number. For sites with version management enabled, this parameter can specify the site version for which the configuration is effective, default is version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: version 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9'], 'Configs' => [ 'description' => 'Response body configurations.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '395386449776640', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'Site configuration version number. For sites with version management enabled, this parameter can specify the site version for which the configuration is effective, default is version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'Rule execution order. The smaller the value, the higher the priority.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Possible values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true.'."\n" - .'- Match specific requests: Set the value to a custom expression, e.g., (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'example' => '(http.host eq \\"video.example.com\\")'."\n", - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'Configuration type, which can be used to query global or rule-based configurations. Possible values:'."\n" - .'- global: Query global configuration.'."\n" - .'- rule: Query rule-based configuration.', - 'type' => 'string', - 'example' => 'global', - 'title' => '', - ], - 'HttpsForce' => [ - 'description' => 'Whether to enable forced HTTPS, default is disabled. Possible values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'HttpsForceCode' => [ - 'description' => 'Forced HTTPS redirect status code. Possible values:'."\n" - .'- 301'."\n" - .'- 302'."\n" - .'- 307'."\n" - .'- 308', - 'type' => 'string', - 'example' => '301', - 'title' => '', - ], - 'AltSvc' => [ - 'description' => 'Alt-Svc feature switch, default is off. Value range: '."\n" - .'- on: enabled. '."\n" - .'- off: disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'AltSvcClear' => [ - 'description' => 'Whether the Alt-Svc header includes the clear parameter, default is off. Values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'AltSvcPersist' => [ - 'description' => 'Whether the Alt-Svc header includes the persist parameter, default is off. Values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'AltSvcMa' => [ - 'description' => 'The validity period of Alt-Svc in seconds, default is 86400 seconds.', - 'type' => 'string', - 'example' => '86400', - 'title' => '', - ], - 'Hsts' => [ - 'description' => 'Whether HSTS is enabled, default is off. Value range:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'HstsMaxAge' => [ - 'description' => 'The expiration time of HSTS in seconds.', - 'type' => 'string', - 'example' => '3600', - 'title' => '', - ], - 'HstsIncludeSubdomains' => [ - 'description' => 'Whether to include subdomains in HSTS, default is off. Value range:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'HstsPreload' => [ - 'description' => 'Whether HSTS preloading is enabled, default is off. Value range:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'HttpsSniVerify' => [ - 'description' => 'Specifies whether to enable SNI validation. Disabled by default. Valid values: '."\n" - .'- on: Enabled. '."\n" - .'- off: Disabled. ', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'HttpsNoSniDeny' => [ - 'description' => 'Specifies whether to deny TLS handshake requests without SNI. Disabled by default. Valid values: '."\n" - .'- on: Enabled. '."\n" - .'- off: Disabled. ', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'HttpsSniWhitelist' => [ - 'description' => 'Specifies the whitelist of allowed SNI entries, separated by spaces. ', - 'type' => 'string', - 'example' => 'abc edf', - 'title' => '', - ], + 'ConfigId' => ['description' => 'Configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '395386449776640', 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: version 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Sequence' => ['description' => 'Rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuleEnable' => ['description' => 'Rule switch. This parameter does not need to be set when adding a global configuration. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'Rule content, using conditional expressions to match user requests. This parameter does not need to be set when adding a global configuration. There are two usage scenarios:'."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + .'- Match specified requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', 'type' => 'string', 'example' => '(http.host eq \\"video.example.com\\")'."\n", 'title' => ''], + 'RuleName' => ['description' => 'Rule name. This parameter does not need to be set when adding a global configuration.', 'type' => 'string', 'example' => 'rule_example', 'title' => ''], + 'ConfigType' => ['description' => 'Configuration type. You can use this parameter to query global configurations or rule configurations. Valid values:'."\n" + ."\n" + .'- global: Query global configurations.'."\n" + .'- rule: Query rule configurations.', 'type' => 'string', 'example' => 'global', 'title' => ''], + 'HttpsForce' => ['description' => 'Whether to enable forced HTTPS. Disabled by default. Valid values:'."\n" + ."\n" + .'- on: Enabled.'."\n" + ."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'HttpsForceCode' => ['description' => 'Forced HTTPS redirect status code. Valid values:'."\n" + .'- 301'."\n" + .'- 302'."\n" + .'- 307'."\n" + .'- 308', 'type' => 'string', 'example' => '301', 'title' => ''], + 'AltSvc' => ['description' => 'Alt-Svc feature switch. Disabled by default. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'AltSvcClear' => ['description' => 'Whether the Alt-Svc header includes the clear parameter. Disabled by default. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'AltSvcPersist' => ['description' => 'Whether the Alt-Svc header includes the persist parameter. Disabled by default. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'AltSvcMa' => ['description' => 'Alt-Svc validity period in seconds. Default value: 86400 seconds.', 'type' => 'string', 'example' => '86400', 'title' => ''], + 'Hsts' => ['description' => 'Whether to enable HSTS. Disabled by default. Valid values:'."\n" + ."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'HstsMaxAge' => ['description' => 'HSTS expiration time in seconds.', 'type' => 'string', 'example' => '3600', 'title' => ''], + 'HstsIncludeSubdomains' => ['description' => 'Whether to include subdomains in HSTS. Disabled by default. Valid values:'."\n" + ."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'HstsPreload' => ['description' => 'Whether to enable HSTS preload. Disabled by default. Valid values:'."\n" + ."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'HttpsSniVerify' => ['description' => 'Whether to enable SNI verification. Disabled by default. Valid values:'."\n" + ."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'HttpsNoSniDeny' => ['description' => 'Whether to enable denial of TLS handshake requests without SNI. Disabled by default. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'HttpsSniWhitelist' => ['description' => 'Specifies the list of allowed SNI whitelist entries, separated by spaces.', 'type' => 'string', 'example' => 'abc edf', 'title' => ''], ], 'description' => '', 'title' => '', @@ -60335,34 +33905,10 @@ 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'description' => 'Current page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'Page size.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'Total number of records.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - 'title' => '', - ], - 'TotalPage' => [ - 'description' => 'Total number of pages.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - 'title' => '', - ], + 'PageNumber' => ['description' => 'Current page number, same as the PageNumber request parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''], + 'TotalPage' => ['description' => 'Total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], 'example' => '', ], @@ -60370,36 +33916,19 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'List HTTPS Application Configurations', + 'staticInfo' => ['returnType' => 'synchronous'], + '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"}]', + 'title' => 'Query HTTPS Application Configuration List', 'changeSet' => [ - [ - 'createdAt' => '2025-06-03T07:09:13.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-06-03T07:09:13.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListHttpsApplicationConfigurations', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHttpsApplicationConfigurations'], ], ], 'ramActions' => [ @@ -60410,263 +33939,132 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => [ - 'summary' => 'Query multiple HTTPS basic configurations', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries multiple HTTPS basic configurations.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257540', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '35281609698****', 'title' => ''], ], [ 'name' => 'ConfigType', 'in' => 'query', 'schema' => [ - 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', - 'description' => 'Configuration type, which can be used to query global or rule configurations. Value range:'."\n" - .'- global: Query global configuration.'."\n" - .'- rule: Query rule configuration.'."\n" + 'title' => '', + 'description' => 'The configuration type. You can use this parameter to query global or rule configurations. Valid values:'."\n" + .'- global: queries global configurations.'."\n" + .'- rule: queries rule configurations.'."\n" ."\n" - .'This parameter is optional. If not provided, it does not distinguish between global and rule configurations.', + .'This parameter is optional. If you do not specify this parameter, both global and rule configurations are returned.', + 'enumValueTitles' => ['rule' => 'rule configuration.', 'global' => 'global configuration.'], 'type' => 'string', + 'enum' => ['global', 'rule'], 'required' => false, 'example' => 'global', - 'enum' => [ - 'global', - 'rule', - ], ], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', - 'description' => 'Rule name, which can be used to find the rule with the specified name.', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['title' => '', 'description' => 'The rule name. You can use this parameter to query the rule that matches the specified name.', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '第几页，不传时默认为1', - 'description' => 'Page number, default is 1 if not provided.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number for a paged query. The value must be greater than or equal to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '每页几条，最大500，不传时默认500', - 'description' => 'Number of items per page, maximum is 500, default is 500 if not provided.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page for a paged query. Valid values: 1 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395'], 'Configs' => [ - 'description' => 'Response body configuration.', + 'description' => 'The configurations returned.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '395386449776640', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'Rule execution order. The smaller the value, the higher the priority.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true.'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'example' => '(http.host eq \\"video.example.com\\")'."\n", - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'Configuration type, which can be used to query global or rule configurations. Value range:'."\n" - .'- global: Query global configuration.'."\n" - .'- rule: Query rule configuration.', - 'type' => 'string', - 'example' => 'global', - 'title' => '', - ], - 'Https' => [ - 'description' => 'Whether to enable HTTPS, default is enabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Tls10' => [ - 'description' => 'Whether to enable TLS1.0, default is disabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Tls11' => [ - 'description' => 'Whether to enable TLS1.1, default is disabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Tls12' => [ - 'description' => 'Whether to enable TLS1.2, default is disabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Tls13' => [ - 'description' => 'Whether to enable TLS1.3, default is disabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'CiphersuiteGroup' => [ - 'description' => 'Ciphersuite group, defaults to enabling all ciphersuites. Value range:'."\n" - .'- all: all ciphersuites.'."\n" - .'- strict: strong ciphersuites.'."\n" - .'- custom: custom ciphersuites.', - 'type' => 'string', - 'example' => 'strict', - 'title' => '', - ], - 'Ciphersuite' => [ - 'description' => 'Custom ciphersuite, indicating the specific encryption algorithm selected when CiphersuiteGroup is set to custom.', - 'type' => 'string', - 'example' => 'TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256', - 'title' => '', - ], - 'OcspStapling' => [ - 'description' => 'Whether to enable OCSP, default is off. Value range:'."\n" - .'- on: enabled.'."\n" - .'- off: disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Http2' => [ - 'description' => 'Whether to enable HTTP2, default is on. Value range:'."\n" - .'- on: enabled.'."\n" - .'- off: disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Http3' => [ - 'description' => 'Whether to enable HTTP3, default is on. Value range:'."\n" - .'- on: enabled.'."\n" - .'- off: disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '395386449776640', 'title' => ''], + 'Sequence' => ['description' => 'The rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuleEnable' => ['description' => 'The rule switch. You do not need to set this parameter when adding a global configuration. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'The rule content, which uses a conditional expression to match user requests. You do not need to set this parameter when adding a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: set the value to true.'."\n" + .'- Match specified requests: set the value to a custom expression, such as (http.host eq \\"video.example.com\\").', 'type' => 'string', 'example' => '(http.host eq \\"video.example.com\\")'."\n", 'title' => ''], + 'RuleName' => ['description' => 'The rule name. You do not need to set this parameter when adding a global configuration.', 'type' => 'string', 'example' => 'rule_example', 'title' => ''], + 'ConfigType' => ['description' => 'The configuration type. You can use this parameter to query global or rule configurations. Valid values:'."\n" + ."\n" + .'- global: queries global configurations.'."\n" + .'- rule: queries rule configurations.', 'type' => 'string', 'example' => 'global', 'title' => ''], + 'Https' => ['description' => 'Specifies whether to enable HTTPS. HTTPS is enabled by default. Valid values:'."\n" + ."\n" + .'- on: enabled.'."\n" + ."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Tls10' => ['description' => 'Specifies whether to enable TLS 1.0. TLS 1.0 is disabled by default. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Tls11' => ['description' => 'Specifies whether to enable TLS 1.1. TLS 1.1 is disabled by default. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Tls12' => ['description' => 'Specifies whether to enable TLS 1.2. TLS 1.2 is disabled by default. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Tls13' => ['description' => 'Specifies whether to enable TLS 1.3. TLS 1.3 is disabled by default. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'CiphersuiteGroup' => ['description' => 'The cipher suite group. All cipher suites are enabled by default. Valid values:'."\n" + .'- all: all cipher suites.'."\n" + .'- strict: strong cipher suites.'."\n" + .'- custom: custom cipher suites.', 'type' => 'string', 'example' => 'strict', 'title' => ''], + 'Ciphersuite' => ['description' => 'The custom cipher suite, which specifies the encryption algorithms selected when CiphersuiteGroup is set to custom.', 'type' => 'string', 'example' => 'TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256', 'title' => ''], + 'OcspStapling' => ['description' => 'Specifies whether to enable OCSP stapling. OCSP stapling is disabled by default. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Http2' => ['description' => 'Specifies whether to enable HTTP/2. HTTP/2 is enabled by default. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Http3' => ['description' => 'Specifies whether to enable HTTP/3. HTTP/3 is enabled by default. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], ], 'description' => '', 'title' => '', @@ -60675,34 +34073,10 @@ 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'description' => 'Current page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'Page size.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'Total number of records.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], - 'TotalPage' => [ - 'description' => 'Total number of pages.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - 'title' => '', - ], + 'PageNumber' => ['description' => 'The current page number, which is the same as the PageNumber request parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], 'example' => '', ], @@ -60710,260 +34084,152 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', - 'title' => 'Query HTTPS Basic Configuration List', + 'title' => 'Query HTTPS basic configurations', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListHttpsBasicConfigurations', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHttpsBasicConfigurations'], ], ], 'ramActions' => [ [ - 'operationType' => 'none', + 'operationType' => 'list', 'ramAction' => [ 'action' => 'esa:ListHttpsBasicConfigurations', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'operationType' => 'read', ], 'ListImageTransforms' => [ - 'summary' => 'Query Multiple Site Image Transformation Configurations', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the list of image transformation configurations for a site.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257357', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID. Can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID. Can be obtained by calling the [ListImageTransforms](~~2869056~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '352816096987136', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID. You can call the [ListImageTransforms](~~2869056~~) operation to obtain the configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '352816096987136', 'title' => ''], ], [ 'name' => 'ConfigType', 'in' => 'query', 'schema' => [ - 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', - 'description' => 'Configuration type, which can be used to query global or rule configurations. Possible values:'."\n" - .'- global: Query global configuration;'."\n" - .'- rule: Query rule configuration;'."\n" + 'title' => '', + 'description' => 'The configuration type. You can use this parameter to query global or rule configurations. Valid values:'."\n" + .'- global: queries global configurations.'."\n" + .'- rule: queries rule configurations.'."\n" ."\n" - .'This parameter is optional. If not provided, it will not distinguish between global and rule configurations.', + .'This parameter is optional. If not specified, both global and rule configurations are returned.', + 'enumValueTitles' => ['rule' => 'rule configuration.', 'global' => 'global configuration.'], 'type' => 'string', + 'enum' => ['global', 'rule'], 'required' => false, 'example' => 'global', - 'enum' => [ - 'global', - 'rule', - ], ], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'test1', - ], + 'schema' => ['title' => '', 'description' => 'The rule name. This parameter is not required when you add a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'test1'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '第几页，不传时默认为1', - 'description' => 'Page number. The default value is 1 if not provided.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number for a paged query. The value must be greater than or equal to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '每页几条，最大500，不传时默认500', - 'description' => 'Number of items per page. The maximum value is 500, and the default value is 500 if not provided.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page for a paged query. Valid values: 1 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Site version number. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. The default value is version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'], 'Configs' => [ - 'description' => 'Configuration list.', + 'description' => 'The list of configurations.', 'type' => 'array', 'items' => [ - 'description' => 'Response body configuration.', + 'description' => 'The configuration details.', 'type' => 'object', 'properties' => [ - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '395386449776640', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'Site configuration version number. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. The default value is version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'Rule execution order. The smaller the value, the higher the priority.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '395386449776640', 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Sequence' => ['description' => 'The execution order of the rule. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Enable' => [ - 'description' => 'Switch. Possible values:'."\n" + 'description' => 'The switch status. Valid values:'."\n" ."\n" - .'- **on**: Enabled.'."\n" - .'- **off**: Disabled.', + .'- **on**: enabled.'."\n" + .'- **off**: disabled.', + 'enumValueTitles' => ['off' => 'off', 'on' => 'on'], 'type' => 'string', - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], 'example' => 'on', 'title' => '', ], 'RuleEnable' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Possible values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', + 'description' => 'The rule switch. This parameter is not required when you add a global configuration. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', + 'enumValueTitles' => ['on' => 'on'], 'type' => 'string', - 'enumValueTitles' => [ - 'on' => 'on', - ], 'example' => 'on', 'title' => '', ], - 'Rule' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'example' => '(http.request.uri.path.file_name eq \\"jpg\\")', - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'example' => 'test', - 'title' => '', - ], + 'Rule' => ['description' => 'The rule content, which uses conditional expressions to match user requests. This parameter is not required when you add a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: set the value to true.'."\n" + .'- Match specified requests: set the value to a custom expression, such as (http.host eq \\"video.example.com\\").', 'type' => 'string', 'example' => '(http.request.uri.path.file_name eq \\"jpg\\")', 'title' => ''], + 'RuleName' => ['description' => 'The rule name. This parameter is not required when you add a global configuration.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'ConfigType' => [ - 'description' => 'Configuration type. Possible values:'."\n" - .'- global: Global configuration;'."\n" - .'- rule: Rule configuration;', + 'description' => 'The configuration type. Valid values:'."\n" + .'- global: global configuration.'."\n" + .'- rule: rule configuration.', + 'enumValueTitles' => ['rule' => 'rule', 'global' => 'global'], 'type' => 'string', - 'enumValueTitles' => [ - 'rule' => 'rule', - 'global' => 'global', - ], 'example' => 'global', 'title' => '', ], + 'AutoWebp' => ['title' => '', 'description' => 'The adaptive WebP setting.', 'type' => 'string', 'example' => 'on'], + 'AutoAvif' => ['title' => '', 'description' => 'The adaptive AVIF setting.', 'type' => 'string', 'example' => 'on'], ], 'title' => '', 'example' => '', @@ -60971,34 +34237,10 @@ 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'description' => 'Current page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'Page size. Range: **1~500**, default is **500**.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'Total number of records.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - 'title' => '', - ], - 'TotalPage' => [ - 'description' => 'Total number of pages.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - 'title' => '', - ], + 'PageNumber' => ['description' => 'The current page number, which is the same as the PageNumber request parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Valid values: **1 to 500**. Default value: **500**.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], 'example' => '', ], @@ -61006,32 +34248,17 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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"}]', - 'title' => 'Query Multiple Site Image Transformation Configurations', + 'staticInfo' => ['returnType' => 'synchronous'], + '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 \\"AutoWebp\\": \\"on\\",\\n \\"AutoAvif\\": \\"on\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 16,\\n \\"TotalPage\\": 2\\n}","type":"json"}]', + 'title' => 'Query image transformation configurations for a site', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListImageTransforms', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListImageTransforms'], ], ], 'ramActions' => [ @@ -61042,51 +34269,40 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'operationType' => 'read', ], 'ListInstanceQuotas' => [ - 'summary' => 'Queries the quota details in a subscription plan.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the quota details of the plan associated with a specific instance or site by quota name.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238984', - 'abilityTreeNodes' => [ - 'FEATUREdcdnZA9EPX', - ], + 'abilityTreeNodes' => ['FEATUREdcdnZA9EPX'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ - 'description' => 'The plan ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", + 'description' => 'The plan instance ID. You can call the [ListSites](~~2850189~~) operation to obtain the ID. You must specify at least one of this parameter and SiteId.', 'type' => 'string', + 'enum' => [], 'required' => false, 'example' => 'sp-xcdn-96wblslz****', - 'enum' => [], 'title' => '', ], ], @@ -61094,114 +34310,107 @@ 'name' => 'SiteId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2882900****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the ID. You must specify at least one of this parameter and InstanceId.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2882900****', 'title' => ''], ], [ 'name' => 'QuotaNames', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ - 'description' => 'The quota names in the plan. Separate multiple names with commas (,). Valid values:'."\n" - ."\n" - .'* **waf:phase:http_anti_scan:actions**: the actions in WAF scan protection rules.'."\n" - .'* **waf:phase:http_bot:actions**: all actions in WAF bot management rules.'."\n" - .'* **waf:phase:http_bot:http_custom_cc_dev:characteristic:fields**: the statistical objects for the custom device-based throttling in WAF bot management rules.'."\n" - .'* **waf:phase:http_bot:http_custom_cc_ip:characteristic:fields**: the statistical objects for the custom IP address-based throttling in WAF bot management rules.'."\n" - .'* ****waf:phase:http_bot:match:symbols****: the match operators in WAF bot management rules.'."\n" - .'* **waf:phase:http_bot:http_custom_cc:characteristic:fields**: the statistical objects for the custom session-based throttling in WAF bot management rules.'."\n" - .'* **waf:phase:http_bot:match:fields**: the match fields in WAF bot management rules.'."\n" - .'* **waf:phase:http_whitelist:match:symbols**: the match operators in WAF whitelist rules.'."\n" - .'* **waf:phase:http_whitelist:match:fields**: the match fields in WAF whitelist rules.'."\n" - .'* **waf:phase:http_anti_scan:http_directory_traversal:characteristic:fields**: the statistical objects for directory traversal blocking in WAF scan protection rules.'."\n" - .'* **waf:phase:http_anti_scan:http_high_frequency:characteristic:fields**: the statistical objects for high-frequency scanning blocking in WAF scan protection rules.'."\n" - .'* **waf:phase:http_anti_scan:match:symbols**: the match operators in WAF scan protection rules.'."\n" - .'* **waf:phase:http_anti_scan:match:fields**: the match fields in WAF scan protection rules.'."\n" - .'* **waf:phase:http_managed:actions**: the actions in WAF managed rules.'."\n" - .'* **waf:phase:http_managed:group:reference:ids**: the referenced rule groups in WAF managed rules.'."\n" - .'* **waf:phase:http_ratelimit:actions**: the actions in WAF rate limiting rules.'."\n" - .'* **waf:phase:http_ratelimit:ttls**: the action durations in WAF rate limiting rules.'."\n" - .'* **waf:phase:http_ratelimit:intervals**: the statistical durations in WAF rate limiting rules.'."\n" - .'* **waf:phase:http_ratelimit:http_ratelimit:characteristic:fields**: the match characteristics in WAF rate limiting rules.'."\n" - .'* **waf:phase:http_ratelimit:match:symbols**: the match operators in WAF rate limiting rules.'."\n" - .'* **waf:phase:http_ratelimit:match:fields**: the match fields in WAF rate limiting rules.'."\n" - .'* **waf:phase:http_custom:actions**: the actions in custom WAF rules.'."\n" - .'* **waf:phase:http_custom:match:symbols**: the match operators in custom WAF rules.'."\n" - .'* **waf:phase:http_custom:match:fields**: the match fields in custom WAF rules.'."\n" - .'* **waiting_room|queuing_method**: the queuing method in Waiting Room.'."\n" - .'* **origin_rules|origin_scheme**: the origin protocol in origin rules.'."\n" - .'* **origin_rules|origin_sni**: the origin Server Name Indication (SNI) in origin rules.'."\n" - .'* **origin_rules|origin_host**: the origin host in origin rules.'."\n" - .'* **fourlayeracceleration**: TCP/UDP proxy.'."\n" - .'* **rtlog_service**: the availability to collect real-time logs.'."\n" - .'* **dashboard_traffic**: the value-added capability of traffic analytics.'."\n" - .'* **custom_name_server**: the availability to configure custom nameservers.'."\n" - .'* **waf:phase:http_bot:enable**: the availability to enable WAF bot management.'."\n" - .'* **waf:phase:http_whitelist:enable**: the availability to configure WAF whitelist rules.'."\n" - .'* **instantlog**: the availability to collect instant logs.'."\n" - .'* **waf:phase:http_anti_scan:enable**: the availability to enable WAF scan protection.'."\n" - .'* **waf:phase:http_managed:group:reference:enable**: the availability to configure reference rule groups in WAF managed rules.'."\n" - .'* **waf:phase:http_managed:enable**: the availability to configure WAF managed rules.'."\n" - .'* **waf:phase:http_ratelimit:on_hit:enable**: the availability to configure whether to apply rate limiting to all requests that hit the cache.'."\n" - .'* **ddos**: DDoS mitigation.'."\n" - .'* **waf:phase:http_ratelimit:enable**: the availability to configure WAF rate limiting.'."\n" - .'* **waf:phase:http_custom:enable**: the availability to configure custom WAF rules.'."\n" - .'* **waf:phase:all:page:reference:enable**: the availability to configure custom error pages.'."\n" - .'* **rules_support_regex**: the support for regular expressions in rules engine.'."\n" - .'* **waiting_room_event**: scheduled events in Waiting Room.'."\n" - .'* **waiting_room_rule**: the availability to allow requests to bypass the waiting room.'."\n" - .'* **waiting_room|json_response**: the availability to enable JSON response in Waiting Room.'."\n" - .'* **waiting_room|disable_session_renewal**: the availability to disable session renewal in Waiting Room.'."\n" - .'* **origin_rules|dns_record**: DNS records in origin rules.'."\n" - .'* **managed_transforms|add_client_geolocation_headers**: the availability to configure whether to add geolocation headers in transform rules.'."\n" - .'* **tiered_cache|regional_enable**: regional tiered cache.'."\n" - .'* **real_client_ip_header**: the availability to configure whether to add the real IP address of a client to the request header.'."\n" - .'* **data_timerange**: minute-level time range for data query.'."\n" - .'* **cache_rules|edge_cache_ttl**: POP cache TTL.'."\n" - .'* **cache_rules|browser_cache_ttl**: browser cache TTL.'."\n" - .'* **fourLayerRecordCount**: the maximum number of records of websites for which TCP/UDP acceleration is enabled.'."\n" - .'* **waitingroomRuleCount**: the maximum number of rules per waiting room.'."\n" - .'* **waitingroomEventCount**: the maximum number of events per waiting room.'."\n" - .'* **waitingroom_custom_pathhost**: the availability to configure the hostname and path in Waiting Room.'."\n" - .'* **er_routers**: Edge Routine routes.'."\n" - .'* **cache_rules|rule_quota**: the maximum number of cache rules.'."\n" - .'* **configuration_rules|rule_quota**: the maximum number of configuration rules.'."\n" - .'* **redirect_rules|rule_quota**: the redirect rules.'."\n" - .'* **compression_rules|rule_quota**: the maximum number of compression rules.'."\n" - .'* **origin_rules|rule_quota**: the maximum number of origin rules.'."\n" - .'* **waf:phase:http_bot:rulesets_per_instance:less_than_or_equal**: the maximum number of rulesets in WAF bot management per plan.'."\n" - .'* **waf:phase:http_whitelist:rules_per_instance:less_than_or_equal**: the maximum number of WAF whitelist rules per plan.'."\n" - .'* **rtlog_quota**: the maximum number of real-time log delivery tasks.'."\n" - .'* **waf:phase:http_anti_scan:rulesets_per_instance:less_than_or_equal**: the maximum number of rulesets in WAF scan protection per plan.'."\n" - .'* **ddos_instance**: the number of Anti-DDoS Proxy instances.'."\n" - .'* **waf:phase:http_ratelimit:rules_per_instance:less_than_or_equal**: the maximum number of WAF rate limiting rules.'."\n" - .'* **waf:phase:http_custom:rules_per_instance:less_than_or_equal**: the maximum number of custom WAF rules per plan.'."\n" - .'* **ruleNestedConditionalCount**: the number of nested layers in a rule.'."\n" - .'* **waiting_room_rule**: Waiting Room.'."\n" - .'* **transition_rule**: the maximum number of transform rules.'."\n" - .'* **customHttpCert**: the maximum number of custom certificates.'."\n" - .'* **free_cert**: the maximum number of free certificates.'."\n" - .'* **preload**: prefetch.'."\n" - .'* **refresh_cache_tag**: purge by cache tag.'."\n" - .'* **refresh_ignore_param**: purge by URL with specified parameters ignored.'."\n" - .'* **refresh_directory**: purge by directory.'."\n" - .'* **refresh_hostname**: purge by hostname.'."\n" - .'* **refresh_all**: purge all cache.'."\n" - .'* **refresh_file**: purge by URL.'."\n" - .'* **wildcard**: the maximum number of wildcard domains.'."\n" - .'* **recordCount**: the maximum number of Layer 7 records.'."\n" - .'* **siteCount**: the maximum number of websites that can be associated with the plan.'."\n" - .'* **https|rule_quota**: the maximum number of SSL/TLS rules.'."\n", + 'description' => 'The plan quota names, separated by commas (,). Valid values:'."\n" + ."\n" + .'- **waf:phase:http_anti_scan:actions**: WAF scan protection - action enumeration.'."\n" + .'- **waf:phase:http_bot:actions**: WAF bot management - all action enumeration.'."\n" + .'- **waf:phase:http_bot:http_custom_cc_dev:characteristic:fields**: WAF bot management - custom device rate limiting statistical object enumeration.'."\n" + .'- **waf:phase:http_bot:http_custom_cc_ip:characteristic:fields**: WAF bot management - custom IP rate limiting statistical object enumeration.'."\n" + .'- **waf:phase:http_bot:match:symbols**: WAF bot management - match operator enumeration.'."\n" + .'- **waf:phase:http_bot:http_custom_cc:characteristic:fields**: WAF bot management - custom session rate limiting statistical object enumeration.'."\n" + .'- **waf:phase:http_bot:match:fields**: WAF bot management - match field enumeration.'."\n" + .'- **waf:phase:http_whitelist:match:symbols**: WAF whitelist - match operator enumeration.'."\n" + .'- **waf:phase:http_whitelist:match:fields**: WAF whitelist - match field enumeration.'."\n" + .'- **waf:phase:http_anti_scan:http_directory_traversal:characteristic:fields**: WAF scan protection - folder traverse blocking statistical object enumeration.'."\n" + .'- **waf:phase:http_anti_scan:http_high_frequency:characteristic:fields**: WAF scan protection - high-frequency scan blocking statistical object enumeration.'."\n" + .'- **waf:phase:http_anti_scan:match:symbols**: WAF scan protection - match operator enumeration.'."\n" + .'- **waf:phase:http_anti_scan:match:fields**: WAF scan protection - match field enumeration.'."\n" + .'- **waf:phase:http_managed:actions**: WAF managed rules - action enumeration.'."\n" + .'- **waf:phase:http_managed:group:reference:ids**: WAF managed rules - referenced rule group enumeration.'."\n" + .'- **waf:phase:http_ratelimit:actions**: WAF rate limiting - action enumeration.'."\n" + .'- **waf:phase:http_ratelimit:ttls**: WAF rate limiting - duration enumeration.'."\n" + .'- **waf:phase:http_ratelimit:intervals**: WAF rate limiting - statistical period.'."\n" + .'- **waf:phase:http_ratelimit:http_ratelimit:characteristic:fields**: WAF rate limiting - control type rule match characteristic enumeration.'."\n" + .'- **waf:phase:http_ratelimit:match:symbols**: WAF rate limiting rule phase match operator enumeration.'."\n" + .'- **waf:phase:http_ratelimit:match:fields**: WAF rate limiting rule phase match field enumeration.'."\n" + .'- **waf:phase:http_custom:actions**: WAF custom rule phase action enumeration.'."\n" + .'- **waf:phase:http_custom:match:symbols**: WAF custom rule phase match operator enumeration.'."\n" + .'- **waf:phase:http_custom:match:fields**: WAF custom rule phase match field.'."\n" + .'- **waiting_room|queuing_method**: waiting room - queuing method.'."\n" + .'- **origin_rules|origin_scheme**: back-to-origin rules - back-to-origin protocol.'."\n" + .'- **origin_rules|origin_sni**: back-to-origin rules - back-to-origin SNI.'."\n" + .'- **origin_rules|origin_host**: back-to-origin rules - back-to-origin host.'."\n" + .'- **fourlayeracceleration**: Layer 4 acceleration.'."\n" + .'- **rtlog_service**: real-time log feature switch.'."\n" + .'- **dashboard_traffic**: value-added network traffic analysis capability.'."\n" + .'- **custom_name_server**: custom NS name.'."\n" + .'- **waf:phase:http_bot:enable**: WAF bot management switch.'."\n" + .'- **waf:phase:http_whitelist:enable**: WAF whitelist switch.'."\n" + .'- **instantlog**: instant log active or not.'."\n" + .'- **waf:phase:http_anti_scan:enable**: WAF scan protection switch.'."\n" + .'- **waf:phase:http_managed:group:reference:enable**: WAF managed rules - referenced rule group configuration switch.'."\n" + .'- **waf:phase:http_managed:enable**: WAF managed rules switch.'."\n" + .'- **waf:phase:http_ratelimit:on_hit:enable**: WAF rate limiting - apply to cache-hit requests switch.'."\n" + .'- **ddos**: DDoS instance.'."\n" + .'- **waf:phase:http_ratelimit:enable**: WAF rate limiting rule phase switch.'."\n" + .'- **waf:phase:http_custom:enable**: WAF custom rule phase switch.'."\n" + .'- **waf:phase:all:page:reference:enable**: WAF custom response page switch.'."\n" + .'- **rules_support_regex**: whether the rule DPI engine supports regular expressions.'."\n" + .'- **waiting_room_event**: waiting room - scheduled event.'."\n" + .'- **waiting_room_rule**: waiting room - bypass waiting room.'."\n" + .'- **waiting_room|json_response**: waiting room - enable JSON response.'."\n" + .'- **waiting_room|disable_session_renewal**: waiting room - disable session renewal.'."\n" + .'- **origin_rules|dns_record**: back-to-origin rules - DNS record.'."\n" + .'- **managed_transforms|add_client_geolocation_headers**: whether the real client IP header is active in transform rules.'."\n" + .'- **tiered_cache|regional_enable**: area cache.'."\n" + .'- **real_client_ip_header**: client IP header.'."\n" + .'- **data_timerange**: data query time range in minutes.'."\n" + .'- **cache_rules|edge_cache_ttl**: cache - node TTL.'."\n" + .'- **cache_rules|browser_cache_ttl**: cache - browser TTL.'."\n" + .'- **fourLayerRecordCount**: record count limit for Layer 4 acceleration.'."\n" + .'- **waitingroomRuleCount**: maximum number of rules per waiting room ID.'."\n" + .'- **waitingroomEventCount**: maximum number of events per waiting room ID.'."\n" + .'- **waitingroom_custom_pathhost**: waiting room - hostname and path.'."\n" + .'- **er_routers**: function routing.'."\n" + .'- **cache_rules|rule_quota**: cache rules.'."\n" + .'- **configuration_rules|rule_quota**: configuration rules.'."\n" + .'- **redirect_rules|rule_quota**: redirect rules.'."\n" + .'- **compression_rules|rule_quota**: compression rules.'."\n" + .'- **origin_rules|rule_quota**: back-to-origin rules.'."\n" + .'- **waf:phase:http_bot:rulesets_per_instance:less_than_or_equal**: WAF bot management - maximum number of rule groups per instance.'."\n" + .'- **waf:phase:http_whitelist:rules_per_instance:less_than_or_equal**: WAF whitelist - maximum number of rules per instance.'."\n" + .'- **rtlog_quota**: quota for real-time log push node count.'."\n" + .'- **waf:phase:http_anti_scan:rulesets_per_instance:less_than_or_equal**: WAF scan protection - maximum number of rule groups per instance.'."\n" + .'- **ddos_instance**: number of DDoS instances.'."\n" + .'- **waf:phase:http_ratelimit:rules_per_instance:less_than_or_equal**: maximum number of WAF rate limiting rules.'."\n" + .'- **waf:phase:http_custom:rules_per_instance:less_than_or_equal**: maximum number of WAF custom rules per instance.'."\n" + .'- **ruleNestedConditionalCount**: number of nesting levels for rules.'."\n" + .'- **waiting_room**: waiting room.'."\n" + .'- **transition_rule**: transform rules.'."\n" + .'- **customHttpCert**: number of custom certificates.'."\n" + .'- **free_cert**: number of free certificates.'."\n" + .'- **preload**: resource prefetch.'."\n" + .'- **refresh_cache_tag**: refresh - cache tag.'."\n" + .'- **refresh_ignore_param**: refresh - purge without parameters.'."\n" + .'- **refresh_directory**: refresh - purge by folder.'."\n" + .'- **refresh_hostname**: refresh - purge by hostname.'."\n" + .'- **refresh_all**: refresh - purge all cache.'."\n" + .'- **refresh_file**: URL refresh.'."\n" + .'- **wildcard**: number of wildcard domain names.'."\n" + .'- **recordCount**: number of Layer 7 records.'."\n" + .'- **siteCount**: number of sites.'."\n" + .'- **https|rule_quota**: number of SSL/TLS rules.', 'type' => 'string', 'required' => true, - 'example' => 'preload, free_cert', 'enum' => [], + 'example' => 'waf:phase:http_anti_scan:actions, waf:phase:http_bot:actions, siteCount', 'title' => '', ], ], @@ -61209,63 +34418,33 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247B78', - ], - 'InstanceId' => [ - 'description' => 'The plan ID.'."\n", - 'type' => 'string', - 'example' => 'sp-xcdn-96wblslz****', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The plan status. Valid values:'."\n" - ."\n" - .'* online: The plan is in service.'."\n" - .'* offline: The plan has expired within an allowable period. In this state, the plan is unavailable.'."\n" - .'* disable: The plan is released.'."\n", - 'type' => 'string', - 'example' => 'online', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247B78'], + 'InstanceId' => ['description' => 'The plan instance ID.', 'type' => 'string', 'example' => 'sp-xcdn-96wblslz****', 'title' => ''], + 'Status' => ['description' => 'The plan instance status. Valid values:'."\n" + ."\n" + .'- **online**: The instance is in normal service.'."\n" + .'- **offline**: The instance has expired but has not exceeded the grace period and is unavailable.'."\n" + .'- **disable**: The instance has been released.', 'type' => 'string', 'example' => 'online', 'title' => ''], 'Quotas' => [ - 'description' => 'The quotas in the plan.'."\n", + 'description' => 'The list of plan instance quotas.', 'type' => 'array', 'items' => [ - 'description' => 'The quota details in the plan.'."\n", + 'description' => 'The plan instance quota details.', 'type' => 'object', 'properties' => [ - 'QuotaName' => [ - 'description' => 'The quota name.'."\n", - 'type' => 'string', - 'example' => 'customHttpCert', - 'title' => '', - ], - 'QuotaValue' => [ - 'description' => 'The quota value.'."\n", - 'type' => 'string', - 'example' => '10', - 'title' => '', - ], - 'QuotaValueType' => [ - 'description' => 'The threshold type of the quota. Valid values:'."\n" - ."\n" - .'* value: enumerates the values of the quota.'."\n" - .'* bool: specifies whether the quota is available.'."\n" - .'* num: the upper limit of the quota.'."\n" - .'* range: the value range for the quota.'."\n" - .'* custom: other types than the preceding four quota threshold types.'."\n", - 'type' => 'string', - 'example' => 'bool', - 'title' => '', - ], + 'QuotaName' => ['description' => 'The quota name.', 'type' => 'string', 'example' => 'customHttpCert', 'title' => ''], + 'QuotaValue' => ['description' => 'The quota value.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'QuotaValueType' => ['description' => 'The threshold type of the quota. Valid values:'."\n" + ."\n" + .'- **value**: enumeration type. The enumeration range of quota values.'."\n" + .'- **bool**: Boolean type. Indicates whether the quota is available.'."\n" + .'- **num**: numeric type. The maximum usage of the quota.'."\n" + .'- **range**: range type. The value range of the quota.'."\n" + .'- **custom**: custom type. Other types that do not fall into the preceding four threshold types.', 'type' => 'string', 'example' => 'bool', 'title' => ''], ], 'title' => '', 'example' => '', @@ -61280,66 +34459,32 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'QuotaNotExist', - 'errorMessage' => 'The quota item does not exist or the purchased plan has not taken effect. Confirm and try again.', - 'description' => 'The quota item does not exist or the purchased plan has not taken effect. Confirm and try again.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'ErService.HasOpened', - 'errorMessage' => 'You have already activated Edge Routine.', - 'description' => 'You have already activated Edge Routine.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'QuotaNotExist', 'errorMessage' => 'The quota item does not exist or the purchased plan has not taken effect. Confirm and try again.', 'description' => 'The quota item does not exist or the purchased plan has not taken effect. Confirm and try again.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'ErService.HasOpened', 'errorMessage' => 'You have already activated Edge Routine.', 'description' => 'You have already activated Edge Routine.'], ], 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' => '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.', - ], + ['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' => '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.'], ], [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], - [ - 'errorCode' => 'UnsupportQuota', - 'errorMessage' => 'Unsupported quota is specified. Check and try again.', - 'description' => 'Unsupported quota is specified. Check and try again.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], + ['errorCode' => 'UnsupportQuota', 'errorMessage' => 'Unsupported quota is specified. Check and try again.', 'description' => 'Unsupported quota is specified. Check and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], '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"}]', - 'title' => 'ListInstanceQuotas', + 'title' => 'Query quota details of an instance', 'changeSet' => [ - [ - 'createdAt' => '2024-10-15T09:23:51.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-10-15T09:23:51.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListInstanceQuotas', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstanceQuotas'], ], ], 'ramActions' => [ @@ -61350,30 +34495,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'operationType' => 'read', - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], ], 'ListInstanceQuotasWithUsage' => [ 'summary' => 'Queries quotas and the actual usage in a plan based on the website or plan ID.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -61385,9 +34516,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238752', - 'abilityTreeNodes' => [ - 'FEATUREdcdnZA9EPX', - ], + 'abilityTreeNodes' => ['FEATUREdcdnZA9EPX'], ], 'parameters' => [ [ @@ -61406,14 +34535,7 @@ 'name' => 'SiteId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1232223****', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1232223****', 'title' => ''], ], [ 'name' => 'QuotaNames', @@ -61446,28 +34568,13 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '85H66C7B-671A-4297-9187-2C4477247A74', - ], - 'InstanceId' => [ - 'description' => 'The plan ID.[](~~2850189~~)'."\n", - 'type' => 'string', - 'example' => 'sp-xcdn-96wblslz****', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The plan status. Valid values:'."\n" - ."\n" - .'* online: The plan is in service.'."\n" - .'* offline: The plan has expired within an allowable period. In this state, the plan is unavailable.'."\n" - .'* disable: The plan is released.'."\n", - 'type' => 'string', - 'example' => 'online', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '85H66C7B-671A-4297-9187-2C4477247A74'], + 'InstanceId' => ['description' => 'The plan ID.[](~~2850189~~)'."\n", 'type' => 'string', 'example' => 'sp-xcdn-96wblslz****', 'title' => ''], + 'Status' => ['description' => 'The plan status. Valid values:'."\n" + ."\n" + .'* online: The plan is in service.'."\n" + .'* offline: The plan has expired within an allowable period. In this state, the plan is unavailable.'."\n" + .'* disable: The plan is released.'."\n", 'type' => 'string', 'example' => 'online', 'title' => ''], 'Quotas' => [ 'description' => 'The quotas and their actual usage in the plan.'."\n", 'type' => 'array', @@ -61475,24 +34582,9 @@ 'description' => 'The details of the quota and the quota usage in the plan.'."\n", 'type' => 'object', 'properties' => [ - 'QuotaName' => [ - 'description' => 'The quota name.'."\n", - 'type' => 'string', - 'example' => 'redirect_rules|rule_quota', - 'title' => '', - ], - 'QuotaValue' => [ - 'description' => 'The quota value.'."\n", - 'type' => 'string', - 'example' => '10', - 'title' => '', - ], - 'Usage' => [ - 'description' => 'The quota usage.'."\n", - 'type' => 'string', - 'example' => '3', - 'title' => '', - ], + 'QuotaName' => ['description' => 'The quota name.'."\n", 'type' => 'string', 'example' => 'redirect_rules|rule_quota', 'title' => ''], + 'QuotaValue' => ['description' => 'The quota value.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], + 'Usage' => ['description' => 'The quota usage.'."\n", 'type' => 'string', 'example' => '3', 'title' => ''], 'SiteUsage' => [ 'description' => 'The usage of the quota in each website associated with the plan.'."\n", 'type' => 'array', @@ -61500,25 +34592,9 @@ 'description' => 'The usage details of the quota in a single website.'."\n", 'type' => 'object', 'properties' => [ - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '34818329392****', - 'title' => '', - ], - 'SiteUsage' => [ - 'description' => 'The quota usage of the website.'."\n", - 'type' => 'string', - 'example' => '1', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'test.top', - 'title' => '', - ], + 'SiteId' => ['description' => 'The website ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '34818329392****', 'title' => ''], + 'SiteUsage' => ['description' => 'The quota usage of the website.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'SiteName' => ['description' => 'The website name.'."\n", 'type' => 'string', 'example' => 'test.top', 'title' => ''], ], 'title' => '', 'example' => '', @@ -61540,75 +34616,30 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'QuotaNotExist', - 'errorMessage' => 'The quota item does not exist or the purchased plan has not taken effect. Confirm and try again.', - 'description' => 'The quota item does not exist or the purchased plan has not taken effect. Confirm and try again.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'ErService.HasOpened', - 'errorMessage' => 'You have already activated Edge Routine.', - 'description' => 'You have already activated Edge Routine.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'QuotaNotExist', 'errorMessage' => 'The quota item does not exist or the purchased plan has not taken effect. Confirm and try again.', 'description' => 'The quota item does not exist or the purchased plan has not taken effect. Confirm and try again.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['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' => '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.'], + ['errorCode' => 'ErService.HasOpened', 'errorMessage' => 'You have already activated Edge Routine.', 'description' => 'You have already activated Edge Routine.'], ], 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' => '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.', - ], + ['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' => '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.'], ], [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], - [ - 'errorCode' => 'UnsupportQuota', - 'errorMessage' => 'Unsupported quota is specified. Check and try again.', - 'description' => 'Unsupported quota is specified. Check and try again.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], + ['errorCode' => 'UnsupportQuota', 'errorMessage' => 'Unsupported quota is specified. Check and try again.', 'description' => 'Unsupported quota is specified. Check and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'ListInstanceQuotasWithUsage', 'changeSet' => [ - [ - 'createdAt' => '2024-10-15T09:23:50.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-10-10T07:16:19.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-10-15T09:23:50.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-10-10T07:16:19.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListInstanceQuotasWithUsage', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstanceQuotasWithUsage'], ], ], 'ramActions' => [ @@ -61619,12 +34650,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -61635,14 +34661,120 @@ 'eventNames' => [], ], ], - 'ListKvs' => [ - 'summary' => 'Lists all key-value pairs in a namespace in your Alibaba Cloud account.', - 'methods' => [ - 'get', + 'ListKeylessServers' => [ + 'summary' => 'Retrieves the list of Keyless server configurations for a site.', + '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' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '90', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '54362329990032', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com ', 'title' => ''], + 'Result' => [ + 'description' => 'The result array.', + 'type' => 'array', + 'items' => [ + 'description' => 'The result.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'Keyless server ID。', 'type' => 'string', 'example' => 'babab9db65ee5efcca9f3d41d4b5****', 'title' => ''], + 'Name' => ['description' => 'The Keyless server name.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'Host' => ['description' => 'The Keyless server hostname.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'Port' => ['description' => 'The Keyless server port. Valid values: 1 to 65535.', 'type' => 'integer', 'format' => 'int64', 'example' => '443', 'title' => ''], + 'Verify' => ['description' => 'Indicates whether to verify the Keyless server certificate. Default value: false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'CaCertificate' => ['description' => 'The CA certificate used to verify the Keyless server certificate. This parameter takes effect only when Verify is set to true.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----****', 'title' => ''], + 'ClientCertificate' => ['description' => 'The client certificate. This parameter must be used together with the client private key.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----****', 'title' => ''], + 'ClientPrivateKey' => ['description' => 'The client private key. This parameter must be used together with the client certificate.', 'type' => 'string', 'example' => '-----BEGIN RSA PRIVATE KEY-----****', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time. The time follows the format YYYY-MM-DDTHH:MM:SS+08:00 in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2025-07-18T20:33:31+08:00', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time. The time follows the format YYYY-MM-DDTHH:MM:SS+08:00 in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2025-07-18T20:33:31+08:00', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ], + 403 => [ + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get keyless server configuration list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListKeylessServers'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListKeylessServers', + '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 \\"TotalCount\\": 90,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"SiteId\\": 54362329990032,\\n \\"SiteName\\": \\"example.com \\",\\n \\"Result\\": [\\n {\\n \\"Id\\": \\"babab9db65ee5efcca9f3d41d4b5****\\",\\n \\"Name\\": \\"example\\",\\n \\"Host\\": \\"example.com\\",\\n \\"Port\\": 443,\\n \\"Verify\\": true,\\n \\"CaCertificate\\": \\"-----BEGIN CERTIFICATE-----****\\",\\n \\"ClientCertificate\\": \\"-----BEGIN CERTIFICATE-----****\\",\\n \\"ClientPrivateKey\\": \\"-----BEGIN RSA PRIVATE KEY-----****\\",\\n \\"CreateTime\\": \\"2025-07-18T20:33:31+08:00\\",\\n \\"UpdateTime\\": \\"2025-07-18T20:33:31+08:00\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListKvs' => [ + 'summary' => 'Lists all key-value pairs in a specified KV storage namespace under your account.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -61655,63 +34787,29 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239076', - 'abilityTreeNodes' => [ - 'FEATUREdcdnGMYWU5', - ], + 'abilityTreeNodes' => ['FEATUREdcdnGMYWU5'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace that you specify when you call the [CreatevNamespace](~~2850317~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_namespace', - 'title' => '', - ], + 'schema' => ['description' => 'The name specified when you called [CreatevNamespace](~~2850317~~).', 'type' => 'string', 'required' => true, 'example' => 'test_namespace', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 50. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '50', - 'default' => '50', - 'title' => '', - ], + 'schema' => ['description' => 'The page size. Default value: **50**. Maximum value: **100**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '50', 'example' => '50', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. The product of PageNumber and PageSize cannot exceed 50,000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '10', - 'default' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number. The product of PageNumber and PageSize cannot exceed 50000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '10', 'title' => ''], ], [ 'name' => 'Prefix', 'in' => 'query', - 'schema' => [ - 'description' => 'The prefix to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'prefix-', - 'maxLength' => 1000, - 'title' => '', - ], + 'schema' => ['description' => 'The prefix used to filter keys.', 'type' => 'string', 'required' => false, 'maxLength' => 1000, 'example' => 'prefix-', 'title' => ''], ], ], 'responses' => [ @@ -61719,51 +34817,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - 'title' => '', - ], - 'PageNumber' => [ - 'description' => 'The total number of pages returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1024', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', 'title' => ''], + 'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'PageNumber' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1024', 'title' => ''], 'Keys' => [ - 'description' => 'The key-value pairs.'."\n", + 'description' => 'The list of key-value pairs retrieved in this traversal.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The key name.'."\n", - 'type' => 'string', - 'example' => 'Key1', - 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'The time when the key was last updated.'."\n", - 'type' => 'string', - 'example' => '2021-12-13T07:46:03Z', - 'title' => '', - ], + 'Name' => ['description' => 'The name of the key.', 'type' => 'string', 'example' => 'Key1', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the key was last updated, in ISO 8601 format (for example, 2024-01-01T00:00:00+Z).', 'type' => 'string', 'example' => '2021-12-13T07:46:03Z', 'title' => ''], ], 'description' => '', 'title' => '', @@ -61781,145 +34846,49 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidAccount.Malformed', - 'errorMessage' => 'The specified account is invalid.', - 'description' => 'The account number is not entered correctly, for example, the input is empty.', - ], - [ - 'errorCode' => 'InvalidNameSpace.Malformed', - 'errorMessage' => 'The specified namespace is invalid.', - 'description' => 'The bucket name is entered incorrectly, such as an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.Malformed', - 'errorMessage' => 'The specified key is invalid.', - 'description' => 'Key name input error, such as entering an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.ExceedsMaximum', - 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', - 'description' => 'The length of the requested key is too large.', - ], - [ - 'errorCode' => 'InvalidValue.ExceedsMaximum', - 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', - 'description' => 'The value deposited is too large.', - ], + ['errorCode' => 'InvalidAccount.Malformed', 'errorMessage' => 'The specified account is invalid.', 'description' => 'The account number is not entered correctly, for example, the input is empty.'], + ['errorCode' => 'InvalidNameSpace.Malformed', 'errorMessage' => 'The specified namespace is invalid.', 'description' => 'The bucket name is entered incorrectly, such as an empty string.'], + ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified key is invalid.', 'description' => 'Key name input error, such as entering an empty string.'], + ['errorCode' => 'InvalidKey.ExceedsMaximum', 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', 'description' => 'The length of the requested key is too large.'], + ['errorCode' => 'InvalidValue.ExceedsMaximum', 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', 'description' => 'The value deposited is too large.'], ], 403 => [ - [ - 'errorCode' => 'InvalidKey.ExceedsCapacity', - 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', - 'description' => 'The capacity of the storage space exceeds the limit.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidParameters', - 'errorMessage' => 'The specified authentication parameters are invalid.', - 'description' => 'Authentication parameter input error.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'InvalidKey.ExceedsCapacity', 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', 'description' => 'The capacity of the storage space exceeds the limit.'], + ['errorCode' => 'Unauthorized.InvalidParameters', 'errorMessage' => 'The specified authentication parameters are invalid.', 'description' => 'Authentication parameter input error.'], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'InvalidAccount.NotFound', - 'errorMessage' => 'The specified account does not exist.', - 'description' => 'The specified account does not exist.', - ], - [ - 'errorCode' => 'InvalidNameSpace.NotFound', - 'errorMessage' => 'The specified namespace does not exist.', - 'description' => '', - ], - [ - 'errorCode' => 'InvalidKey.NotFound', - 'errorMessage' => 'The specified key does not exist.', - 'description' => 'The specified key-value pair does not exist.', - ], + ['errorCode' => 'InvalidAccount.NotFound', 'errorMessage' => 'The specified account does not exist.', 'description' => 'The specified account does not exist.'], + ['errorCode' => 'InvalidNameSpace.NotFound', 'errorMessage' => 'The specified namespace does not exist.', 'description' => ''], + ['errorCode' => 'InvalidKey.NotFound', 'errorMessage' => 'The specified key does not exist.', 'description' => 'The specified key-value pair does not exist.'], ], 406 => [ - [ - 'errorCode' => 'InvalidNameSpace.Duplicate', - 'errorMessage' => 'The specified namespace already exists.', - 'description' => 'Specified storage space', - ], - [ - 'errorCode' => 'InvalidNameSpace.QuotaFull', - 'errorMessage' => 'The maximum number of namespaces is exceeded.', - 'description' => 'The number of storage spaces exceeds the capacity limit.', - ], + ['errorCode' => 'InvalidNameSpace.Duplicate', 'errorMessage' => 'The specified namespace already exists.', 'description' => 'Specified storage space'], + ['errorCode' => 'InvalidNameSpace.QuotaFull', 'errorMessage' => 'The maximum number of namespaces is exceeded.', 'description' => 'The number of storage spaces exceeds the capacity limit.'], ], 429 => [ - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests are submitted.', - 'description' => 'Submissions are too frequent, please try again later', - ], - [ - 'errorCode' => 'TooQuickRequests', - 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', - 'description' => 'The modification or deletion of key-value pairs is too frequent.', - ], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests are submitted.', 'description' => 'Submissions are too frequent, please try again later'], + ['errorCode' => 'TooQuickRequests', 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', 'description' => 'The modification or deletion of key-value pairs is too frequent.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', - 'title' => 'ListKvs', + 'title' => 'List key-value pairs in a KV storage namespace', 'changeSet' => [ - [ - 'createdAt' => '2024-09-20T13:49:27.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-20T13:49:27.000Z', 'description' => 'Error codes changed'], ], '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListKvs'], ], ], + 'ramActions' => [], ], 'ListLists' => [ - 'summary' => 'List all custom lists under the account and their details. You can filter the results by passing query parameters and use paging to retrieve a specific set of lists.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Lists all custom lists under the account along with their details. You can use query parameters to filter results and paginate to retrieve a specific set of lists.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -61932,9 +34901,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239589', - 'abilityTreeNodes' => [ - 'FEATUREdcdnL8HX1L', - ], + 'abilityTreeNodes' => ['FEATUREdcdnL8HX1L'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ @@ -61944,65 +34911,17 @@ 'style' => 'json', 'schema' => [ 'title' => '', - 'description' => 'The query arguments in the JSON format, which contain filter conditions.'."\n", + 'description' => 'The query parameters passed in JSON format, which contain various filter conditions.', 'type' => 'object', 'properties' => [ - 'IdLike' => [ - 'title' => '', - 'description' => 'The list ID for fuzzy search.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '40000001', - ], - 'NameLike' => [ - 'title' => '', - 'description' => 'The list name for fuzzy search.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'example', - ], - 'DescriptionLike' => [ - 'title' => '', - 'description' => 'The list description for fuzzy search.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a custom list', - ], - 'ItemLike' => [ - 'title' => '', - 'description' => 'The list content for fuzzy search.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10.1.1.1', - ], - 'NameItemLike' => [ - 'title' => '', - 'description' => 'The list name and content for fuzzy search.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10.1.1.1', - ], - 'Kind' => [ - 'description' => 'The type of the custom list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ip', - 'title' => '', - ], - 'OrderBy' => [ - 'title' => '', - 'description' => 'The column by which you want to sort the returned data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'id', - ], - 'Desc' => [ - 'title' => '', - 'description' => 'Specifies whether to sort the returned data in descending order.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'IdLike' => ['title' => '', 'description' => 'The value used to fuzzy match list IDs.', 'type' => 'string', 'example' => '40000001', 'required' => false], + 'NameLike' => ['title' => '', 'description' => 'The value used to fuzzy match list names.', 'type' => 'string', 'example' => 'example', 'required' => false], + 'DescriptionLike' => ['title' => '', 'description' => 'The value used to fuzzy match list descriptions.', 'type' => 'string', 'example' => 'a custom list', 'required' => false], + 'ItemLike' => ['title' => '', 'description' => 'The value used to fuzzy match list content.', 'type' => 'string', 'example' => '10.1.1.1', 'required' => false], + 'NameItemLike' => ['title' => '', 'description' => 'The value used to fuzzy match both list content and list names simultaneously.', 'type' => 'string', 'example' => '10.1.1.1', 'required' => false], + 'Kind' => ['description' => 'The kind of the custom list.', 'type' => 'string', 'example' => 'ip', 'required' => false, 'title' => ''], + 'OrderBy' => ['title' => '', 'description' => 'The column by which to sort the results.', 'type' => 'string', 'example' => 'id', 'required' => false], + 'Desc' => ['title' => '', 'description' => 'Specifies whether to sort the results in descending order.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], 'required' => false, 'example' => 'ListLists', @@ -62011,132 +34930,51 @@ [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number for paging.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page for paging.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], - 'TotalCount' => [ - 'title' => '', - 'description' => 'The total number of filtered lists.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'Usage' => [ - 'title' => '', - 'description' => 'The number of created lists.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], + 'TotalCount' => ['title' => '', 'description' => 'The total number of records after filtering.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'Usage' => ['title' => '', 'description' => 'The amount of usage consumed by the user.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], 'Lists' => [ 'title' => '', - 'description' => 'The array that contains list information, including list data after paging.'."\n", + 'description' => 'The array of list information, which contains the paginated list data.', 'type' => 'array', 'items' => [ 'title' => '', - 'description' => 'The list information.'."\n", + 'description' => 'The list information.', 'type' => 'object', 'properties' => [ - 'UpdateTime' => [ - 'title' => '', - 'description' => 'The time when the list was last modified.'."\n", - 'type' => 'string', - 'example' => '2024-01-01T00:00:00Z', - ], - 'Id' => [ - 'title' => '', - 'description' => 'The ID of the custom list.[](~~2850217~~)'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '40000001', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The list name.'."\n", - 'type' => 'string', - 'example' => 'example', - ], - 'Kind' => [ - 'title' => '', - 'description' => 'The list type.'."\n", - 'type' => 'string', - 'example' => 'ip', - ], - 'Description' => [ - 'title' => '', - 'description' => 'The list description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a custom list', - 'maxLength' => 1024, - 'pattern' => '', - 'default' => '', - ], - 'Length' => [ - 'title' => '', - 'description' => 'The length of the list information array, which indicates how many items the list contains.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], + 'UpdateTime' => ['title' => '', 'description' => 'The time when the list was last modified.'."\n" + ."\n" + .'Format: RFC 3339 / ISO 8601, UTC time zone (ending with Z).'."\n" + ."\n" + .'Example: 2026-06-10T14:23:45Z', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], + 'Id' => ['title' => '', 'description' => 'The ID of the custom list. You can obtain the ID by calling the [ListLists](~~2850217~~) operation.', 'type' => 'integer', 'format' => 'int64', 'example' => '40000001'], + 'Name' => ['title' => '', 'description' => 'The list name.', 'type' => 'string', 'example' => 'example'], + 'Kind' => ['title' => '', 'description' => 'The kind of the list.', 'type' => 'string', 'example' => 'ip'], + 'Description' => ['title' => '', 'description' => 'The list description.', 'type' => 'string', 'required' => false, 'example' => 'a custom list', 'maxLength' => 1024, 'pattern' => '', 'default' => ''], + 'Length' => ['title' => '', 'description' => 'The length of the list content array, which indicates the number of items in the list.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], ], 'example' => '', ], 'example' => '', ], - 'PageNumber' => [ - 'title' => '', - 'description' => 'The page number returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'ItemsUsage' => [ - 'description' => 'Total item usage.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5000', - 'title' => '', - ], + 'PageNumber' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'ItemsUsage' => ['description' => 'The total item usage.', 'type' => 'integer', 'format' => 'int64', 'example' => '5000', 'title' => ''], ], 'example' => '', ], @@ -62144,41 +34982,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + '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' => 'List Custom Lists ', + 'title' => 'List custom lists', 'changeSet' => [ - [ - 'createdAt' => '2024-09-25T07:01:32.000Z', - 'description' => 'Error codes changed, Request parameters changed', - ], - [ - 'createdAt' => '2024-09-18T06:56:37.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-25T07:01:32.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2024-09-18T06:56:37.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListLists', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLists'], ], ], 'ramActions' => [ @@ -62189,12 +35006,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -62202,12 +35014,8 @@ ], 'ListLoadBalancerOriginStatus' => [ 'summary' => 'Query the status of origins in load balancers', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -62220,44 +35028,23 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238350', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1159101787****', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1159101787****', 'title' => ''], ], [ 'name' => 'LoadBalancerIds', 'in' => 'query', - 'schema' => [ - 'description' => 'Load balancer ID. When querying multiple load balancers, separate the IDs with commas. A maximum of 100 load balancer IDs can be passed at once. Load balancer IDs can be obtained by calling the [ListLoadBalancers](~~2868897~~) interface.', - 'type' => 'string', - 'required' => true, - 'example' => '99874066052****,100892832360****', - 'title' => '', - ], + 'schema' => ['description' => 'Load balancer ID. When querying multiple load balancers, separate the IDs with commas. A maximum of 100 load balancer IDs can be passed at once. Load balancer IDs can be obtained by calling the [ListLoadBalancers](~~2868897~~) interface.', 'type' => 'string', 'required' => true, 'example' => '99874066052****,100892832360****', 'title' => ''], ], [ 'name' => 'PoolType', 'in' => 'query', - 'schema' => [ - 'description' => 'Source address pool type. Various source address pools are configured under the load balancer, including default pools, fallback pools, and primary region pools. Only the status of origins in the default pool affects the status of the load balancer itself. Passing `default_pool` means only querying the status of origins in the default source address pool under the load balancer.', - 'type' => 'string', - 'required' => false, - 'example' => 'default_pool', - 'title' => '', - ], + 'schema' => ['description' => 'Source address pool type. Various source address pools are configured under the load balancer, including default pools, fallback pools, and primary region pools. Only the status of origins in the default pool affects the status of the load balancer itself. Passing `default_pool` means only querying the status of origins in the default source address pool under the load balancer.', 'type' => 'string', 'required' => false, 'example' => 'default_pool', 'title' => ''], ], ], 'responses' => [ @@ -62267,12 +35054,7 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID, used for tracking the request.', - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID, used for tracking the request.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9'], 'OriginStatus' => [ 'description' => 'List of origin statuses under the load balancer.', 'type' => 'array', @@ -62280,49 +35062,16 @@ 'description' => 'Information about the origin status.', 'type' => 'object', 'properties' => [ - 'LoadBalancerId' => [ - 'description' => 'ID of the load balancer.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '99874066052****', - 'title' => '', - ], - 'OriginId' => [ - 'description' => 'ID of the origin.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '99750209487****', - 'title' => '', - ], - 'PoolId' => [ - 'description' => 'ID of the source address pool.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '99750209487****', - 'title' => '', - ], - 'Status' => [ - 'description' => 'Status of the origin:'."\n" - .'- Healthy(healthy): The probe result is available.'."\n" - .'- Unhealthy(unhealthy): The probe result is unavailable.'."\n" - .'- Unknown(unknown): Unknown, the monitor has not yet probed.'."\n" - .'- Undetected(undetected): The load balancer to which the origin belongs is not bound to a monitor.', - 'type' => 'string', - 'example' => 'healthy', - 'title' => '', - ], - 'Reason' => [ - 'description' => 'Reason for the probe failure.', - 'type' => 'string', - 'example' => 'TCP connection error', - 'title' => '', - ], - 'PoolType' => [ - 'description' => 'The origin pool to which the source belongs, under this load balancer. Only \'default_pool\' (default address pool) will be displayed; other types will return an empty string.', - 'type' => 'string', - 'example' => 'default_pool', - 'title' => '', - ], + 'LoadBalancerId' => ['description' => 'ID of the load balancer.', 'type' => 'integer', 'format' => 'int64', 'example' => '99874066052****', 'title' => ''], + 'OriginId' => ['description' => 'ID of the origin.', 'type' => 'integer', 'format' => 'int64', 'example' => '99750209487****', 'title' => ''], + 'PoolId' => ['description' => 'ID of the source address pool.', 'type' => 'integer', 'format' => 'int64', 'example' => '99750209487****', 'title' => ''], + 'Status' => ['description' => 'Status of the origin:'."\n" + .'- Healthy(healthy): The probe result is available.'."\n" + .'- Unhealthy(unhealthy): The probe result is unavailable.'."\n" + .'- Unknown(unknown): Unknown, the monitor has not yet probed.'."\n" + .'- Undetected(undetected): The load balancer to which the origin belongs is not bound to a monitor.', 'type' => 'string', 'example' => 'healthy', 'title' => ''], + 'Reason' => ['description' => 'Reason for the probe failure.', 'type' => 'string', 'example' => 'TCP connection error', 'title' => ''], + 'PoolType' => ['description' => 'The origin pool to which the source belongs, under this load balancer. Only \'default_pool\' (default address pool) will be displayed; other types will return an empty string.', 'type' => 'string', 'example' => 'default_pool', 'title' => ''], ], 'title' => '', 'example' => '', @@ -62337,28 +35086,14 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => '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.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => '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.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'Query the Status of Origins under Load Balancers', 'description' => 'Query the status of origins under load balancers. You can pass multiple load balancer IDs at once, separated by commas. This is for load balancers that have monitors configured. It will probe the origins in the source address pools used by the load balancers and record the current status of each origin.'."\n" @@ -62370,12 +35105,7 @@ 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListLoadBalancerOriginStatus', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLoadBalancerOriginStatus'], ], ], 'ramActions' => [ @@ -62386,12 +35116,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -62403,12 +35128,8 @@ ], 'ListLoadBalancerRegions' => [ 'summary' => 'Query Load Balancer Region List', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -62421,35 +35142,19 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239637', - 'abilityTreeNodes' => [ - 'FEATUREdcdnWQK30N', - ], + 'abilityTreeNodes' => ['FEATUREdcdnWQK30N'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'Page number.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Page size.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1024', - 'title' => '', - ], + 'schema' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1024', 'title' => ''], ], ], 'responses' => [ @@ -62459,12 +35164,7 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID', - 'type' => 'string', - 'example' => '81A5E222-24BF-17EF-9E80-A68D9B8F363D', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '81A5E222-24BF-17EF-9E80-A68D9B8F363D'], 'Regions' => [ 'description' => 'List of region information', 'type' => 'array', @@ -62472,24 +35172,9 @@ 'description' => 'Region information', 'type' => 'object', 'properties' => [ - 'RegionCode' => [ - 'description' => 'Primary region code', - 'type' => 'string', - 'example' => 'SEAS', - 'title' => '', - ], - 'RegionEnName' => [ - 'description' => 'Primary region English full name', - 'type' => 'string', - 'example' => 'South East Asia', - 'title' => '', - ], - 'RegionCnName' => [ - 'description' => 'Primary region Chinese full name', - 'type' => 'string', - 'example' => '东南亚', - 'title' => '', - ], + 'RegionCode' => ['description' => 'Primary region code', 'type' => 'string', 'example' => 'SEAS', 'title' => ''], + 'RegionEnName' => ['description' => 'Primary region English full name', 'type' => 'string', 'example' => 'South East Asia', 'title' => ''], + 'RegionCnName' => ['description' => 'Primary region Chinese full name', 'type' => 'string', 'example' => '东南亚', 'title' => ''], 'SubRegions' => [ 'description' => 'List of secondary region information', 'type' => 'array', @@ -62497,24 +35182,9 @@ 'description' => 'Secondary region information', 'type' => 'object', 'properties' => [ - 'SubRegionCode' => [ - 'description' => 'Secondary region code', - 'type' => 'string', - 'example' => 'ID', - 'title' => '', - ], - 'SubRegionEnName' => [ - 'description' => 'Secondary region English full name', - 'type' => 'string', - 'example' => 'Indonesia', - 'title' => '', - ], - 'SubRegionCnName' => [ - 'description' => 'Secondary region Chinese full name', - 'type' => 'string', - 'example' => '印度尼西亚', - 'title' => '', - ], + 'SubRegionCode' => ['description' => 'Secondary region code', 'type' => 'string', 'example' => 'ID', 'title' => ''], + 'SubRegionEnName' => ['description' => 'Secondary region English full name', 'type' => 'string', 'example' => 'Indonesia', 'title' => ''], + 'SubRegionCnName' => ['description' => 'Secondary region Chinese full name', 'type' => 'string', 'example' => '印度尼西亚', 'title' => ''], ], 'title' => '', 'example' => '', @@ -62529,34 +35199,10 @@ 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', - 'description' => 'Page number', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'Number of records per page', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1024', - 'title' => '', - ], - 'TotalCount' => [ - 'title' => 'MaxResults本次请求所返回的最大记录条数', - 'description' => 'Total number of records', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'TotalPage' => [ - 'description' => 'Total number of pages', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], + 'PageNumber' => ['title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => 'Number of records per page', 'type' => 'integer', 'format' => 'int32', 'example' => '1024', 'title' => ''], + 'TotalCount' => ['title' => 'MaxResults本次请求所返回的最大记录条数', 'description' => 'Total number of records', 'type' => 'integer', 'format' => 'int32', 'example' => '12'], + 'TotalPage' => ['description' => 'Total number of pages', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'example' => '', ], @@ -62564,28 +35210,16 @@ ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'QueryDBError', - 'errorMessage' => 'An internal exception occurred when query data, please try again later.', - 'description' => 'An internal exception occurred when query data, please try again later.', - ], + ['errorCode' => 'QueryDBError', 'errorMessage' => 'An internal exception occurred when query data, please try again later.', 'description' => 'An internal exception occurred when query data, please try again later.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query Load Balancer Region Information', 'description' => 'When creating a load balancer \'based on country/region scheduling\' strategy through OpenAPI, use the code of primary or secondary regions to represent traffic from this geographical area.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListLoadBalancerRegions', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLoadBalancerRegions'], ], ], 'ramActions' => [ @@ -62596,25 +35230,17 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', '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' => 'Query the list of load balancers', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the list of load balancers under a site and returns load balancing information. You can query by load balancer name. Paging is supported.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -62627,219 +35253,103 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238617', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number for paginated queries.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - 'title' => '', - ], + 'schema' => ['description' => 'The page number settings for the paging query. The value must be greater than or equal to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The page size for paginated queries, with a value range of 1-500.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries per page for the paging query. Valid values: 1 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the load balancer, which can be used to query by name.', - 'type' => 'string', - 'required' => false, - 'example' => 'lb.example.com', - 'title' => '', - ], + 'schema' => ['description' => 'The load balancing name. You can query by name.', 'type' => 'string', 'required' => false, 'example' => 'lb.example.com', 'title' => ''], ], [ 'name' => 'MatchType', 'in' => 'query', - 'schema' => [ - 'description' => 'The name matching strategy when querying by name:'."\n" - ."\n" - .'- fuzzy: Fuzzy match;'."\n" - .'- exact: Exact match, equivalent to an equality query.', - 'type' => 'string', - 'required' => false, - 'example' => 'fuzzy', - 'title' => '', - ], + 'schema' => ['description' => 'The name matching strategy when querying by name. Valid values:'."\n" + ."\n" + .'- fuzzy: fuzzy match.'."\n" + .'- exact: exact match.', 'type' => 'string', 'required' => false, 'example' => 'fuzzy', 'title' => ''], ], [ 'name' => 'OrderBy', 'in' => 'query', - 'schema' => [ - 'description' => 'The sorting field. Currently, only sorting by id is supported. \'id\' indicates ascending order by id, and \'-id\' indicates descending order by id. The id size is positively correlated with the creation time. If not provided, it defaults to descending order by id.', - 'type' => 'string', - 'required' => false, - 'example' => 'id', - 'title' => '', - ], + 'schema' => ['description' => 'The sort field. Currently, only sorting by ID is supported. id indicates ascending order by ID, and -id indicates descending order by ID. The ID value is positively correlated with the creation time. If this parameter is not specified, the default sort order is descending by ID.', 'type' => 'string', 'required' => false, 'example' => 'id', 'title' => ''], ], [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The site ID, which can be obtained by calling the [ListSites](~~ListSites~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '21655860979****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '21655860979****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', 'title' => ''], 'LoadBalancers' => [ - 'description' => 'An array format that returns the list of load balancers.', + 'description' => 'The list of load balancing instances returned in array format.', 'type' => 'array', 'items' => [ - 'description' => 'Detailed information about the load balancer.', + 'description' => 'The details of a load balancing instance.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The unique identifier ID of the load balancer.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '998676487607104', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The name of the load balancer.', - 'type' => 'string', - 'example' => 'lb.example.com'."\n", - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'The site ID to which the load balancer belongs.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1159101787****', - 'title' => '', - ], - 'Enabled' => [ - 'description' => 'Whether the load balancer is enabled.'."\n" - ."\n" - .'- true: Enabled.'."\n" - .'- false: Not enabled.', - 'type' => 'boolean', - 'example' => 'false', - 'title' => '', - ], - 'Ttl' => [ - 'description' => 'The TTL value, which is the DNS record\'s time to live, with a default value of 30.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - 'title' => '', - ], - 'SessionAffinity' => [ - 'description' => 'Session persistence, with possible values:'."\n" - .'- off: Not enabled.'."\n" - .'- ip: Session persistence by IP.'."\n" - .'- cookie: Session persistence by cookie.', - 'type' => 'string', - 'example' => 'ip', - 'title' => '', - ], - 'FallbackPool' => [ - 'description' => 'The fallback pool ID, to which traffic will be redirected if all other pools are unavailable.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '96228666776****', - 'title' => '', - ], - 'SteeringPolicy' => [ - 'description' => 'The load balancing policy.', - 'type' => 'string', - 'example' => 'order', - 'title' => '', - ], - 'Description' => [ - 'description' => 'The description of the load balancer.', - 'type' => 'string', - 'example' => 'test', - 'title' => '', - ], + 'Id' => ['description' => 'The unique identity ID of the load balancing instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '998676487607104', 'title' => ''], + 'Name' => ['description' => 'The name of the load balancing instance.', 'type' => 'string', 'example' => 'lb.example.com'."\n", 'title' => ''], + 'SiteId' => ['description' => 'The ID of the site to which the load balancing instance belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1159101787****', 'title' => ''], + 'Enabled' => ['description' => 'Indicates whether the load balancing instance is enabled. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Ttl' => ['description' => 'The TTL value, which specifies the time-to-live of the DNS record. Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'SessionAffinity' => ['description' => 'The session persistence mode. Valid values:'."\n" + .'- off: Disabled.'."\n" + .'- ip: IP-based session persistence.'."\n" + .'- cookie: Cookie-based session persistence.'."\n" + .'- http_header: HTTP header-based session persistence.', 'type' => 'string', 'example' => 'ip', 'title' => ''], + 'FallbackPool' => ['description' => 'The ID of the fallback address pool. When all other address pools are unavailable, traffic is redirected to this address pool.', 'type' => 'integer', 'format' => 'int64', 'example' => '96228666776****', 'title' => ''], + 'SteeringPolicy' => ['description' => 'The load balancing policy.', 'type' => 'string', 'example' => 'order', 'title' => ''], + 'Description' => ['description' => 'The description of the load balancing instance.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'AdaptiveRouting' => [ - 'description' => 'Cross-pool failover configuration.', + 'description' => 'The cross-origin address pool back-to-origin configuration.', 'type' => 'object', 'properties' => [ - 'FailoverAcrossPools' => [ - 'description' => 'Whether to fail over across pools.'."\n" - ."\n" - .'- true: Yes.'."\n" - .'- false: No.', - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], + 'FailoverAcrossPools' => ['description' => 'Indicates whether cross-origin address pool failover is enabled. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'OriginLevelRetry' => ['description' => 'Specifies whether to retry the next IP address when back-to-origin fails and the origin server is a domain name that resolves to multiple IP addresses.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'DefaultPools' => [ - 'description' => 'List of default address pool IDs.', + 'description' => 'The list of default address pool IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'Default pools.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '96228666776****', - 'title' => '', - ], + 'items' => ['description' => 'The default address pool.', 'type' => 'integer', 'format' => 'int64', 'example' => '96228666776****', 'title' => ''], 'title' => '', 'example' => '', ], 'RandomSteering' => [ - 'description' => 'Weighted round-robin configuration, used to control the traffic distribution weights among different pools.', + 'description' => 'The weighted round-robin configuration, which controls the traffic distribution weight across different address pools.', 'type' => 'object', 'properties' => [ - 'DefaultWeight' => [ - 'description' => 'Weight configuration for each backend server pool, where the key is the pool ID and the value is the weight coefficient. The weight coefficient represents the proportion of relative traffic distribution.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50'."\n", - 'title' => '', - ], + 'DefaultWeight' => ['description' => 'The weight configuration for each backend server pool. The key is the pool ID and the value is the weight coefficient. The weight coefficient represents the relative proportion of traffic distribution.', 'type' => 'integer', 'format' => 'int32', 'example' => '50'."\n", 'title' => ''], 'PoolWeights' => [ - 'description' => 'Weight configuration for each backend server pool, where the key is the pool ID and the value is the weight coefficient.', + 'description' => 'The weight configuration for each backend server pool. The key is the pool ID and the value is the weight coefficient.', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => 'The weight value, a number between 0-100, where 0 indicates no traffic should be directed to that origin server.', - 'example' => '50'."\n", - 'title' => '', - ], + 'additionalProperties' => ['description' => 'The weight value. Valid values: 0 to 100. A value of 0 indicates that no traffic is routed to the origin server.', 'type' => 'integer', 'format' => 'int32', 'example' => '50'."\n", 'title' => ''], 'title' => '', 'example' => '', ], @@ -62848,138 +35358,86 @@ 'example' => '', ], 'Rules' => [ - 'description' => 'List of rule configurations, used to define behaviors under specific conditions.', + 'description' => 'The list of rule configurations that define behaviors under specific conditions.', 'type' => 'array', 'items' => [ - 'description' => 'Rule configuration within the rule set.', + 'description' => 'The rule configuration in the rule set.', 'type' => 'object', 'properties' => [ 'FixedResponse' => [ - 'description' => 'Executes a specified response after matching the rule.', + 'description' => 'The fixed response content returned after a rule is matched.', 'type' => 'object', 'properties' => [ - 'ContentType' => [ - 'description' => 'The Content-Type field in the HTTP Header.', - 'type' => 'string', - 'example' => 'application/json'."\n", - 'title' => '', - ], - 'Location' => [ - 'description' => 'The location field in the HTTP response.', - 'type' => 'string', - 'example' => 'http://www.example.com/index.html'."\n", - 'title' => '', - ], - 'MessageBody' => [ - 'description' => 'The response body value.', - 'type' => 'string', - 'example' => 'Hello World.'."\n", - 'title' => '', - ], - 'StatusCode' => [ - 'description' => 'Status code.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - 'title' => '', - ], + 'ContentType' => ['description' => 'The Content-Type field in the HTTP header.', 'type' => 'string', 'example' => 'application/json'."\n", 'title' => ''], + 'Location' => ['description' => 'The location field in the HTTP response.', 'type' => 'string', 'example' => 'http://www.example.com/index.html'."\n", 'title' => ''], + 'MessageBody' => ['description' => 'The response body value.', 'type' => 'string', 'example' => 'Hello World.'."\n", 'title' => ''], + 'StatusCode' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], 'title' => '', 'example' => '', ], - 'Overrides' => [ - 'description' => 'Modifies the corresponding load balancer configuration after matching the rule. The fields in this configuration will override the corresponding fields in the load balancer configuration.', - '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" - .' }', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding global configurations. There are two usage scenarios: '."\n" - .'- Match all incoming requests: set the value to true '."\n" - .'- Match specific requests: set the value to a custom expression, for example: (http.host eq "video.example.com")', - 'type' => 'string', - 'example' => 'http.request.uri.path contains "/testing"'."\n", - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'The name of the rule. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'example' => 'r2', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'The switch for the rule. This parameter is not required when adding a global configuration. Possible values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'The execution order of the rule. The higher the value, the higher the priority.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Terminates' => [ - 'description' => 'Whether to terminate the execution of subsequent rules.'."\n" - ."\n" - .'- true: Yes.'."\n" - .'- false: No, which is the default value.', - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], + 'Overrides' => ['description' => 'The load balancing configuration overrides applied after a rule is matched. The configured fields override the corresponding fields in the load balancer configuration.', '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" + .' }', 'title' => ''], + 'Rule' => ['description' => 'The rule content, which uses conditional expressions to match user requests. This parameter does not need to be set when adding a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + .'- Match specific requests: Set the value to a custom expression, such as (http.host eq \\"video.example.com\\").', 'type' => 'string', 'example' => 'http.request.uri.path contains "/testing"'."\n", 'title' => ''], + 'RuleName' => ['description' => 'The rule name. This parameter does not need to be set when adding a global configuration.', 'type' => 'string', 'example' => 'r2', 'title' => ''], + 'RuleEnable' => ['description' => 'The rule switch. This parameter does not need to be set when adding a global configuration. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Sequence' => ['description' => 'The rule execution order. A higher value indicates higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Terminates' => ['description' => 'Indicates whether to stop executing subsequent rules. Valid values:'."\n" + ."\n" + .'- true: Yes.'."\n" + .'- false: No. This is the default value.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', @@ -62988,128 +35446,48 @@ 'example' => '', ], 'Monitor' => [ - 'description' => 'Monitor configuration.', + 'description' => 'The monitor configuration.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The type of monitor protocol, such as HTTP, used for health checks. When the value is `off`, it indicates that no check will be performed.', - 'type' => 'string', - 'example' => 'HTTP'."\n", - 'title' => '', - ], - 'Method' => [ - 'description' => 'The method for the health check.', - 'type' => 'string', - 'example' => 'GET'."\n", - 'title' => '', - ], - 'Port' => [ - 'description' => 'The target port.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80'."\n", - 'title' => '', - ], - 'Path' => [ - 'description' => 'The path.', - 'type' => 'string', - 'example' => '/'."\n", - 'title' => '', - ], - 'Interval' => [ - 'description' => 'The interval for the health check, in seconds.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - 'title' => '', - ], - 'ExpectedCodes' => [ - 'description' => 'The expected status codes, such as 200,202, indicating successful HTTP responses.', - 'type' => 'string', - 'example' => '200,202'."\n", - 'title' => '', - ], - 'FollowRedirects' => [ - 'description' => 'Whether to follow redirects.'."\n" - ."\n" - .'- true: Yes.'."\n" - .'- false: No.', - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], - 'ConsecutiveUp' => [ - 'description' => 'The number of consecutive successful probes required to consider the target healthy, such as 3.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'title' => '', - ], - 'ConsecutiveDown' => [ - 'description' => 'The number of consecutive failed probes required to consider the target unhealthy, such as 5.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'title' => '', - ], - 'Header' => [ - 'description' => 'The header information included in the probe, such as HTTP headers.', - 'type' => 'any', - 'example' => '{'."\n" - .' "host": ['."\n" - .' "example1.com",'."\n" - .' "example2.com"'."\n" - .' ]'."\n" - .' }', - 'title' => '', - ], - 'Timeout' => [ - 'description' => 'Application health check timeout, in seconds.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'title' => '', - ], - 'MonitoringRegion' => [ - 'description' => 'The area where the detection point is located. The default value is Global.'."\n" - ."\n" - .'- Global: Global.'."\n" - .'- ChineseMainland: The Chinese mainland.'."\n" - .'- OutsideChineseMainland: Global (excluding the Chinese mainland).', - 'type' => 'string', - 'example' => 'Global', - 'title' => '', - ], + 'Type' => ['description' => 'The monitor protocol type, such as HTTP, used for health checks. A value of off indicates that no health check is performed.', 'type' => 'string', 'example' => 'HTTP'."\n", 'title' => ''], + 'Method' => ['description' => 'The method used for the health check.', 'type' => 'string', 'example' => 'GET'."\n", 'title' => ''], + 'Port' => ['description' => 'The target port.', 'type' => 'integer', 'format' => 'int32', 'example' => '80'."\n", 'title' => ''], + 'Path' => ['description' => 'The path.', 'type' => 'string', 'example' => '/'."\n", 'title' => ''], + 'Interval' => ['description' => 'The interval of the health check, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'ExpectedCodes' => ['description' => 'The expected status codes for a successful HTTP response, such as 200,202.', 'type' => 'string', 'example' => '200,202'."\n", 'title' => ''], + 'FollowRedirects' => ['description' => 'Indicates whether to follow redirects. Valid values:'."\n" + ."\n" + .'- true: Yes.'."\n" + .'- false: No.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ConsecutiveUp' => ['description' => 'The number of consecutive successful probes required to consider the check successful, such as 3.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'ConsecutiveDown' => ['description' => 'The number of consecutive failed probes required to consider the check failed, such as 5.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'Header' => ['description' => 'The HTTP header information included in the probe request.', 'type' => 'any', 'example' => '{'."\n" + .' "host": ['."\n" + .' "example1.com",'."\n" + .' "example2.com"'."\n" + .' ]'."\n" + .' }', 'title' => ''], + 'Timeout' => ['description' => 'The timeout period of the health check, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'MonitoringRegion' => ['description' => 'The region where the probe nodes are located. Default value: Global. Valid values:'."\n" + ."\n" + .'- Global: worldwide.'."\n" + .'- ChineseMainland: the Chinese mainland.'."\n" + .'- OutsideChineseMainland: worldwide (excluding the Chinese mainland).', 'type' => 'string', 'example' => 'Global', 'title' => ''], ], 'title' => '', 'example' => '', ], - 'Status' => [ - 'description' => 'The status of the load balancer.', - 'type' => 'string', - 'example' => 'healthy', - 'title' => '', - ], - 'SubRegionPools' => [ - 'description' => 'Address pools corresponding to secondary regions. When multiple secondary regions share a set of address pools, the keys can be concatenated with commas.', - 'type' => 'any', - 'example' => '{"AL,MO": [92298024898****],"CN-SH,CN-SX,CN-SC":[92304347804****,92843536908****]}', - 'title' => '', - ], - 'RegionPools' => [ - 'description' => 'Address pools corresponding to primary regions.', - 'type' => 'any', - 'example' => '{'."\n" - .' "ENAM": ['."\n" - .' 12345678****'."\n" - .' ],'."\n" - .' "WNAM": ['."\n" - .' 23456789****,'."\n" - .' 23456789****'."\n" - .' ]'."\n" - .'}', - 'title' => '', - ], + 'Status' => ['description' => 'The status of the load balancing instance.', 'type' => 'string', 'example' => 'healthy', 'title' => ''], + 'SubRegionPools' => ['description' => 'The address pools mapped to secondary regions. When multiple secondary regions share the same set of address pools, the secondary region names can be concatenated with commas as the key.', 'type' => 'any', 'example' => '{"AL,MO": [92298024898****],"CN-SH,CN-SX,CN-SC":[92304347804****,92843536908****]}', 'title' => ''], + 'RegionPools' => ['description' => 'The address pools mapped to primary regions.', 'type' => 'any', 'example' => '{'."\n" + .' "ENAM": ['."\n" + .' 12345678****'."\n" + .' ],'."\n" + .' "WNAM": ['."\n" + .' 23456789****,'."\n" + .' 23456789****'."\n" + .' ]'."\n" + .'}', 'title' => ''], ], 'title' => '', 'example' => '', @@ -63117,34 +35495,10 @@ 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'description' => 'Page number, same as the PageNumber in the request parameters.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'Number of items per page.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'Total number of items.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - 'title' => '', - ], - 'TotalPage' => [ - 'description' => 'Total number of pages.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], + 'PageNumber' => ['description' => 'The page number, which is the same as the PageNumber request parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'example' => '', ], @@ -63152,44 +35506,25 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'Query Load Balancers Under a Site', + '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 \\"OriginLevelRetry\\": 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"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'Query load balancers under a site', 'changeSet' => [ - [ - 'createdAt' => '2025-06-16T02:25:11.000Z', - 'description' => 'Response parameters changed', - ], - [ - 'createdAt' => '2025-02-13T01:34:54.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-06-16T02:25:11.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-02-13T01:34:54.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListLoadBalancers', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLoadBalancers'], ], ], 'ramActions' => [ @@ -63200,27 +35535,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => 'List Custom Managed Rule Groups', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Lists all WAF managed rule groups under the current account. You can call this operation to retrieve a list of all rule groups and their summary information.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -63233,97 +35557,47 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239646', - 'abilityTreeNodes' => [ - 'FEATUREdcdnL8HX1L', - ], + 'abilityTreeNodes' => ['FEATUREdcdnL8HX1L'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '页面号码', - 'description' => 'Page number, used to specify the page number for pagination queries.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number for the paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '页面大小', - 'description' => 'Page size, used to specify the number of items per page for pagination queries.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page for the paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], - 'TotalCount' => [ - 'title' => '过滤后的总记录数', - 'description' => 'Total number of records after filtering.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], + 'TotalCount' => ['title' => '', 'description' => 'The total number of records after filtering.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], 'ManagedRulesGroups' => [ - 'title' => '托管规则组信息列表', - 'description' => 'List of managed rule group information.', + 'title' => '', + 'description' => 'The list of managed rule groups.', 'type' => 'array', 'items' => [ - 'title' => '托管规则组信息', - 'description' => 'Managed rule group information.', + 'title' => '', + 'description' => 'The managed rule group information.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '托管规则组名称', - 'description' => 'Name of the managed rule group.', - 'type' => 'string', - 'example' => 'example', - ], - 'RuleCount' => [ - 'description' => 'Number of rules within the managed rule group.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - 'title' => '', - ], + 'Name' => ['title' => '', 'description' => 'The name of the managed rule group.', 'type' => 'string', 'example' => 'example'], + 'RuleCount' => ['description' => 'The number of rules in the managed rule group.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], ], 'example' => '', ], 'example' => '', ], - 'PageNumber' => [ - 'title' => '页面号码', - 'description' => 'Current page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '页面大小', - 'description' => 'Page size.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], + 'PageNumber' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], ], 'example' => '', ], @@ -63331,40 +35605,23 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', - 'title' => 'List WAF Managed Rule Groups', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'List WAF managed rule groups', 'changeSet' => [ - [ - 'createdAt' => '2024-12-26T15:07:29.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-29T05:46:33.000Z', - 'description' => 'Request parameters changed, Response parameters changed', - ], - [ - 'createdAt' => '2024-09-18T06:56:37.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-12-26T15:07:29.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-29T05:46:33.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-09-18T06:56:37.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListManagedRulesGroups', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListManagedRulesGroups'], ], ], 'ramActions' => [ @@ -63375,243 +35632,122 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListNetworkOptimizations' => [ - 'summary' => 'Query multiple network optimization configurations', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries multiple network optimization configurations.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257562', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1231231221****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1231231221****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3528160969****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3528160969****', 'title' => ''], ], [ 'name' => 'ConfigType', 'in' => 'query', 'schema' => [ - 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', - 'description' => 'Configuration type, which can be used to query global or rule-based configurations. The value range is as follows:'."\n" + 'title' => '', + 'description' => 'The configuration type. You can use this parameter to query global or rule configurations. Valid values:'."\n" ."\n" - .'- global: Query global configuration.'."\n" - .'- rule: Query rule-based configuration.'."\n" + .'- global: queries global configurations.'."\n" + .'- rule: queries rule configurations.'."\n" ."\n" - .'This parameter is optional; if not provided, it does not distinguish between global and rule-based configurations.', + .'This parameter is optional. If you do not specify this parameter, both global and rule configurations are returned.', + 'enumValueTitles' => ['rule' => 'rule configuration.', 'global' => 'global configuration.'], 'type' => 'string', + 'enum' => ['global', 'rule'], 'required' => false, 'example' => 'global', - 'enum' => [ - 'global', - 'rule', - ], ], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', - 'description' => 'Rule name, which can be used to find the rule with the specified name.', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['title' => '', 'description' => 'The rule name. You can use this parameter to query the rule that matches the specified name.', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '第几页，不传时默认为1', - 'description' => 'Page number, defaulting to 1 if not provided.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number for a paged query. The value must be greater than or equal to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '每页几条，最大500，不传时默认500', - 'description' => 'Number of items per page, with a maximum of 500. Defaults to 500 if not provided.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page for a paged query. Valid values: 1 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Site version number. For sites with version management enabled, this parameter can specify the site version for which the configuration takes effect, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'], 'Configs' => [ - 'description' => 'Response body configurations.', + 'description' => 'The configurations returned in the response body.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '395386449776640', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'Site configuration version number. For sites with version management enabled, this parameter can specify the site version for which the configuration takes effect, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'Rule execution order. The smaller the value, the higher the priority.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. The value range is as follows:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, e.g., (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'example' => '(http.host eq \\"video.example.com\\")'."\n", - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'Configuration type, which can be used to query global or rule-based configurations. The value range is as follows:'."\n" - ."\n" - .'- global: Query global configuration.'."\n" - .'- rule: Query rule-based configuration.', - 'type' => 'string', - 'example' => 'global', - 'title' => '', - ], - 'SmartRouting' => [ - 'description' => 'Whether to enable smart routing service, defaulting to off. The value range is as follows:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Http2Origin' => [ - 'description' => 'Whether to enable HTTP2 origin, defaulting to off. The value range is as follows:'."\n" - ."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Websocket' => [ - 'description' => 'Whether to enable Websocket, enabled by default. Value range: '."\n" - .'- on: Enabled. '."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Grpc' => [ - 'description' => 'Whether to enable GRPC, default is off. The value range is:'."\n" - .'- on: enabled.'."\n" - .'- off: disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'UploadMaxFilesize' => [ - 'description' => 'Maximum file size for upload, in MB. The value range is 100 to 500.', - 'type' => 'string', - 'example' => '500', - 'title' => '', - ], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '395386449776640', 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Sequence' => ['description' => 'The rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuleEnable' => ['description' => 'The rule switch. You do not need to set this parameter when adding a global configuration. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'The rule content, which uses conditional expressions to match user requests. You do not need to set this parameter when adding a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: set the value to true.'."\n" + .'- Match specified requests: set the value to a custom expression, such as (http.host eq \\"video.example.com\\").', 'type' => 'string', 'example' => '(http.host eq \\"video.example.com\\")'."\n", 'title' => ''], + 'RuleName' => ['description' => 'The rule name. You do not need to set this parameter when adding a global configuration.', 'type' => 'string', 'example' => 'rule_example', 'title' => ''], + 'ConfigType' => ['description' => 'The configuration type. You can use this parameter to query global or rule configurations. Valid values:'."\n" + ."\n" + .'- global: global configuration.'."\n" + .'- rule: rule configuration.', 'type' => 'string', 'example' => 'global', 'title' => ''], + 'SmartRouting' => ['description' => 'Specifies whether to enable the smart routing service. This feature is disabled by default. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Http2Origin' => ['description' => 'Specifies whether to enable HTTP/2 back-to-origin. This feature is disabled by default. Valid values:'."\n" + ."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Websocket' => ['description' => 'Specifies whether to enable WebSocket. This feature is enabled by default. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Grpc' => ['description' => 'Specifies whether to enable gRPC. This feature is disabled by default. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'UploadMaxFilesize' => ['description' => 'The maximum upload file size, in MB. Valid values: 100 to 500.', 'type' => 'string', 'example' => '500', 'title' => ''], ], 'description' => '', 'title' => '', @@ -63620,34 +35756,10 @@ 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'description' => 'The current page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The size of the page.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'Total number of records.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - 'title' => '', - ], - 'TotalPage' => [ - 'description' => 'Total number of pages.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - 'title' => '', - ], + 'PageNumber' => ['description' => 'The current page number, which is the same as the PageNumber request parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], 'example' => '', ], @@ -63655,32 +35767,17 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', - 'title' => 'Query Network Optimization Configurations List', + 'title' => 'Query network optimization configurations', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListNetworkOptimizations', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNetworkOptimizations'], ], ], 'ramActions' => [ @@ -63691,25 +35788,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'operationType' => 'read', ], 'ListOriginCaCertificates' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the list of origin server CA certificates.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -63722,193 +35810,60 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '261742', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: **20**. Valid values: 1 to 500.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: **20**. Valid values: **1 to 500**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - 'title' => '', - ], - 'PageNumber' => [ - 'description' => 'Page number, default is 1 if not provided.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456789****', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com ', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789****', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com ', 'title' => ''], 'Result' => [ - 'description' => 'Details of the certificates.'."\n", + 'description' => 'The result.', 'type' => 'array', 'items' => [ - 'description' => 'The certificate information.'."\n", + 'description' => 'The certificate information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'example' => 'babaabcd****', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The certificate name.'."\n", - 'type' => 'string', - 'example' => 'yourCertName', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The certificate status.'."\n", - 'type' => 'string', - 'example' => 'OK', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The certificate type.'."\n" - .'* upload: custom certificate that you upload', - 'type' => 'string', - 'example' => 'upload', - 'title' => '', - ], - 'CommonName' => [ - 'description' => 'The Common Name of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com', - 'title' => '', - ], - 'NotBefore' => [ - 'description' => 'The time when the certificate takes effect.'."\n", - 'type' => 'string', - 'example' => '2023-11-26T16:00:00Z', - 'title' => '', - ], - 'NotAfter' => [ - 'description' => 'The time when the certificate expires.'."\n", - 'type' => 'string', - 'example' => '2024-03-31 02:08:00', - 'title' => '', - ], - 'Issuer' => [ - 'description' => 'The certificate authority (CA) that issued the certificate.'."\n", - 'type' => 'string', - 'example' => 'GlobalSign nv-sa', - 'title' => '', - ], - 'SAN' => [ - 'description' => 'The Subject Alternative Name (SAN) of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com,*.example.com', - 'title' => '', - ], - 'SignatureAlgorithm' => [ - 'description' => 'The signature algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'SHA256-RSA', - 'title' => '', - ], - 'PubkeyAlgorithm' => [ - 'description' => 'The public-key algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'RSA', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the certificate was created.'."\n", - 'type' => 'string', - 'example' => '2024-06-24 07:48:51', - 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'The time when the certificate was updated.'."\n", - 'type' => 'string', - 'example' => '2024-07-20 06:18:42', - 'title' => '', - ], - 'SerialNumber' => [ - 'description' => 'The serial number of the certificate.'."\n", - 'type' => 'string', - 'example' => 'babaded901474b9693acf530e0fb1d**', - 'title' => '', - ], - 'FingerprintSha256' => [ - 'description' => 'The SHA-256 fingerprint of the certificate.'."\n", - 'type' => 'string', - 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', - 'title' => '', - ], + 'Id' => ['description' => 'The certificate ID.', 'type' => 'string', 'example' => 'babaabcd****', 'title' => ''], + 'Name' => ['description' => 'The certificate name.', 'type' => 'string', 'example' => 'yourCertName', 'title' => ''], + 'Status' => ['description' => 'The certificate status.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Type' => ['description' => 'The certificate type.', 'type' => 'string', 'example' => 'upload', 'title' => ''], + 'CommonName' => ['description' => 'The common name of the certificate.', 'type' => 'string', 'example' => 'www.example.com', 'title' => ''], + 'NotBefore' => ['description' => 'The start time of the certificate validity period. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2023-11-26 16:00:00', 'title' => ''], + 'NotAfter' => ['description' => 'The end time of the certificate validity period. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-03-31 02:08:00', 'title' => ''], + 'Issuer' => ['description' => 'The certification authority.', 'type' => 'string', 'example' => 'GlobalSign nv-sa', 'title' => ''], + 'SAN' => ['description' => 'The Subject Alternative Name (SAN) of the certificate.', 'type' => 'string', 'example' => 'www.example.com,*.example.com', 'title' => ''], + 'SignatureAlgorithm' => ['description' => 'The signature algorithm of the certificate.', 'type' => 'string', 'example' => 'SHA256-RSA', 'title' => ''], + 'PubkeyAlgorithm' => ['description' => 'The public key algorithm of the certificate.', 'type' => 'string', 'example' => 'RSA', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-06-24 07:48:51', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time. Format: YYYY-MM-DD HH:MM:SS, in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-07-20 06:18:42', 'title' => ''], + 'SerialNumber' => ['description' => 'The certificate serial number.', 'type' => 'string', 'example' => 'babaded901474b9693acf530e0fb1d**', 'title' => ''], + 'FingerprintSha256' => ['description' => 'The SHA-256 fingerprint of the certificate.', 'type' => 'string', 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', 'title' => ''], ], 'title' => '', 'example' => '', @@ -63923,49 +35878,22 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'ListOriginCaCertificates ', - 'summary' => 'Query the list of CA certificates for origin servers.', + 'staticInfo' => ['returnType' => 'synchronous'], + '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-26 16:00: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\\": \\"babaded901474b9693acf530e0fb1d**\\",\\n \\"FingerprintSha256\\": \\"1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListOriginCaCertificates', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '20', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListOriginCaCertificates', - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOriginCaCertificates'], ], ], 'ramActions' => [ @@ -63976,26 +35904,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => 'Query the list of origin fetch client certificates by domain name granularity.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the list of back-to-origin client certificates at the domain name granularity.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -64008,204 +35926,66 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '261754', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number. Default value: **1**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3558df77-8a7a-4060-a900-2d7949403836', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - 'title' => '', - ], - 'PageNumber' => [ - 'description' => 'The page number. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456789****', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com'."\n", - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3558df77-8a7a-4060-a900-2d7949403836', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'PageNumber' => ['description' => 'The page number. Default value: **1**.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789****', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com'."\n", 'title' => ''], 'Result' => [ - 'description' => 'The certificate information.'."\n", + 'description' => 'The list of certificate information.', 'type' => 'array', 'items' => [ - 'description' => 'The certificate information.'."\n", + 'description' => 'The certificate information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'example' => 'babaabcd****', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The certificate name.'."\n", - 'type' => 'string', - 'example' => 'yourCertName', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The certificate status.'."\n", - 'type' => 'string', - 'example' => 'OK', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The certificate type.'."\n" - .'* upload: custom certificate that you upload', - 'type' => 'string', - 'example' => 'upload', - 'title' => '', - ], - 'CommonName' => [ - 'description' => 'The Common Name of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com ', - 'title' => '', - ], - 'NotBefore' => [ - 'description' => 'The time when the certificate takes effect.'."\n", - 'type' => 'string', - 'example' => '2023-03-31 02:08:00', - 'title' => '', - ], - 'NotAfter' => [ - 'description' => 'The time when the certificate expires.'."\n", - 'type' => 'string', - 'example' => '2024-03-31 02:08:00', - 'title' => '', - ], - 'Issuer' => [ - 'description' => 'The certificate authority (CA) that issued the certificate.'."\n", - 'type' => 'string', - 'example' => 'DigiCert', - 'title' => '', - ], - 'SAN' => [ - 'description' => 'The Subject Alternative Name (SAN) of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com,*.example.com', + 'Id' => ['description' => 'The certificate ID.', 'type' => 'string', 'example' => 'babaabcd****', 'title' => ''], + 'Name' => ['description' => 'The certificate name.', 'type' => 'string', 'example' => 'yourCertName', 'title' => ''], + 'Status' => ['description' => 'The certificate status.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Type' => ['description' => 'The certificate type.', 'type' => 'string', 'example' => 'upload', 'title' => ''], + 'CommonName' => ['description' => 'The common name of the certificate.', 'type' => 'string', 'example' => 'www.example.com ', 'title' => ''], + 'NotBefore' => ['description' => 'The start time of the certificate validity period. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2023-03-31 02:08:00', 'title' => ''], + 'NotAfter' => ['description' => 'The end time of the certificate validity period. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-03-31 02:08:00', 'title' => ''], + 'Issuer' => ['description' => 'The certification authority.', 'type' => 'string', 'example' => 'DigiCert', 'title' => ''], + 'SAN' => ['description' => 'The Subject Alternative Name (SAN) of the certificate.', 'type' => 'string', 'example' => 'www.example.com,*.example.com', 'title' => ''], + 'SignatureAlgorithm' => ['description' => 'The signature algorithm of the certificate.', 'type' => 'string', 'example' => 'SHA256-RSA', 'title' => ''], + 'PubkeyAlgorithm' => ['description' => 'The public key algorithm of the certificate.', 'type' => 'string', 'example' => 'RSA', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-06-24 07:48:51', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-07-20 06:18:42', 'title' => ''], + 'SerialNumber' => ['description' => 'The certificate serial number.', 'type' => 'string', 'example' => 'babaded901474b9693acf530e0fb1d**', 'title' => ''], + 'FingerprintSha256' => ['description' => 'The SHA-256 fingerprint of the certificate.', 'type' => 'string', 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', 'title' => ''], + 'Hostnames' => [ + 'description' => 'The list of associated domain names.', + 'type' => 'array', + 'items' => ['description' => 'The domain name.', 'type' => 'string', 'example' => 'www.example.com', 'title' => ''], 'title' => '', - ], - 'SignatureAlgorithm' => [ - 'description' => 'The signature algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'SHA256-RSA', - 'title' => '', - ], - 'PubkeyAlgorithm' => [ - 'description' => 'The public-key algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'RSA', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the certificate was created.'."\n", - 'type' => 'string', - 'example' => '2024-06-24 07:48:51', - 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'The time when the certificate was updated.'."\n", - 'type' => 'string', - 'example' => '2024-07-20 06:18:42', - 'title' => '', - ], - 'SerialNumber' => [ - 'description' => 'The serial number of the certificate.'."\n", - 'type' => 'string', - 'example' => 'babaded901474b9693acf530e0fb1d**', - 'title' => '', - ], - 'FingerprintSha256' => [ - 'description' => 'The SHA-256 fingerprint of the certificate.'."\n", - 'type' => 'string', - 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', - 'title' => '', - ], - 'Hostnames' => [ - 'description' => 'The domain names to associate.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'example' => 'www.example.com', - 'title' => '', - ], - 'title' => '', - 'example' => '', + 'example' => '', ], ], 'title' => '', @@ -64221,45 +36001,21 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], ], - 'title' => 'Query the origin fetch client certificate list by domain granularity', + '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"}]', + 'title' => 'Query back-to-origin client certificates by domain name', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '20', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListOriginClientCertificates', - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOriginClientCertificates'], ], ], 'ramActions' => [ @@ -64270,26 +36026,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => 'List Origin Pools', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Lists all origin pools within a site. Supports pagination and searching by origin pool name (exact or fuzzy).', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -64302,166 +36048,85 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238398', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'Page number, default value is 1.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Page size, an integer greater than 0, with a maximum of 500. If the value exceeds 500, it will be set to 500.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries per page. The value must be an integer from 1 to 500. If you specify a value greater than 500, the system uses 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'Name of the origin pool.', - 'type' => 'string', - 'required' => false, - 'example' => 'pool1', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the origin pool.', 'type' => 'string', 'required' => false, 'example' => 'pool1', 'title' => ''], ], [ 'name' => 'MatchType', 'in' => 'query', - 'schema' => [ - 'description' => 'Type of name match query, supporting the following two types, with exact match as the default.'."\n" - ."\n" - .'- fuzzy: Fuzzy query.'."\n" - .'- exact: Exact query.', - 'type' => 'string', - 'required' => false, - 'example' => 'exact', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies how to match the origin pool name. The default is `exact`. Valid values:'."\n" + ."\n" + .'- `fuzzy`: Performs a fuzzy search.'."\n" + ."\n" + .'- `exact`: Performs an exact match.', 'type' => 'string', 'required' => false, 'example' => 'exact', 'title' => ''], ], [ 'name' => 'OrderBy', 'in' => 'query', - 'schema' => [ - 'description' => 'Sorting, supports ascending and descending order by ID, default is descending by ID, which is positively correlated with creation time.'."\n" - ."\n" - .'- -id: Sort by ID in descending order.'."\n" - .'- id: Sort by ID in ascending order.', - 'type' => 'string', - 'required' => false, - 'example' => 'id', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies how the results are sorted. By default, results are sorted by ID in descending order. To sort by ID in ascending order, set this parameter to `id`. IDs increase with creation time.'."\n" + ."\n" + .'- id: Sorts by ID in descending order.'."\n" + ."\n" + .'- id: Sorts by ID in ascending order.', 'type' => 'string', 'required' => false, 'example' => 'id', 'title' => ''], ], [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '151538882642832', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. To get this ID, call the [ListSites](~~ListSites~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '151538882642832', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', 'title' => ''], 'OriginPools' => [ - 'description' => 'List of origin pools.', + 'description' => 'A list of origin pools.', 'type' => 'array', 'items' => [ - 'description' => 'Information about the origin pool.', + 'description' => 'An origin pool.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'ID of the origin pool.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1038520525196928', - 'title' => '', - ], - 'Name' => [ - 'description' => 'Name of the origin pool, unique within a site.', - 'type' => 'string', - 'example' => 'pool1', - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'ID of the site to which the origin pool belongs.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '216558609793952', - 'title' => '', - ], - 'RecordName' => [ - 'description' => 'Domain name assigned to the origin pool, which can be used as the origin address for records under the site.', - 'type' => 'string', - 'example' => 'pool1.example.com'."\n", - 'title' => '', - ], - 'Enabled' => [ - 'description' => 'Whether the origin pool is enabled:'."\n" - ."\n" - .'- true: Enabled;'."\n" - .'- false: Disabled.', - 'type' => 'boolean', - 'example' => 'false', - 'title' => '', - ], + 'Id' => ['description' => 'The ID of the origin pool.', 'type' => 'integer', 'format' => 'int64', 'example' => '1038520525196928', 'title' => ''], + 'Name' => ['description' => 'The name of the origin pool. The name must be unique within a site.', 'type' => 'string', 'example' => 'pool1', 'title' => ''], + 'SiteId' => ['description' => 'The ID of the site to which the origin pool belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '216558609793952', 'title' => ''], + 'RecordName' => ['description' => 'The domain name assigned to the origin pool. This can be used as the origin address for records within the site.', 'type' => 'string', 'example' => 'pool1.example.com'."\n", 'title' => ''], + 'Enabled' => ['description' => 'Indicates whether the origin pool is enabled.'."\n" + ."\n" + .'- `true`: Enabled.'."\n" + ."\n" + .'- `false`: Disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'References' => [ - 'description' => 'Reference information for the origin pool. The origin pool is considered referenced when it is configured in a load balancer or set as the origin for a record.', + 'description' => 'The resources that reference this origin pool. An origin pool is considered referenced when it is configured as an origin for a load balancer or a record.', 'type' => 'object', 'properties' => [ 'LoadBalancers' => [ - 'description' => 'List of load balancers using this origin pool.', + 'description' => 'A list of load balancers that use this origin pool.', 'type' => 'array', 'items' => [ - 'description' => 'Information about the load balancers using this origin pool.', + 'description' => 'A load balancer that uses this origin pool.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'Name of the load balancer.', - 'type' => 'string', - 'example' => 'lb1.example.com'."\n", - 'title' => '', - ], - 'Id' => [ - 'description' => 'ID of the load balancer.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '998740660522624'."\n", - 'title' => '', - ], + 'Name' => ['description' => 'The name of the load balancer.', 'type' => 'string', 'example' => 'lb1.example.com'."\n", 'title' => ''], + 'Id' => ['description' => 'The ID of the load balancer.', 'type' => 'integer', 'format' => 'int64', 'example' => '998740660522624'."\n", 'title' => ''], ], 'title' => '', 'example' => '', @@ -64470,25 +36135,14 @@ 'example' => '', ], 'DnsRecords' => [ - 'description' => '使用此源地址池为源站的七层记录列表。', + 'description' => 'A list of Layer 7 records that use this origin pool as an origin.', 'type' => 'array', 'items' => [ - 'description' => 'Information about the layer 7 records that use this origin pool as the origin.', + 'description' => 'A Layer 7 record that uses this origin pool as an origin.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'Record name.', - 'type' => 'string', - 'example' => 'www.example.com'."\n", - 'title' => '', - ], - 'Id' => [ - 'description' => 'Record ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1042852886352704', - 'title' => '', - ], + 'Name' => ['description' => 'The name of the record.', 'type' => 'string', 'example' => 'www.example.com'."\n", 'title' => ''], + 'Id' => ['description' => 'The ID of the record.', 'type' => 'integer', 'format' => 'int64', 'example' => '1042852886352704', 'title' => ''], ], 'title' => '', 'example' => '', @@ -64497,25 +36151,14 @@ 'example' => '', ], 'IPARecords' => [ - 'description' => 'List of layer 4 records that use this origin pool as the origin.', + 'description' => 'A list of Layer 4 records that use this origin pool as an origin.', 'type' => 'array', 'items' => [ - 'description' => 'Information about the layer 4 records that use this origin pool as the origin.', + 'description' => 'A Layer 4 record that uses this origin pool as an origin.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'Record name.', - 'type' => 'string', - 'example' => 'ipa.example.com'."\n", - 'title' => '', - ], - 'Id' => [ - 'description' => 'Record ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1042852886352704'."\n", - 'title' => '', - ], + 'Name' => ['description' => 'The name of the record.', 'type' => 'string', 'example' => 'ipa.example.com'."\n", 'title' => ''], + 'Id' => ['description' => 'The ID of the record.', 'type' => 'integer', 'format' => 'int64', 'example' => '1042852886352704'."\n", 'title' => ''], ], 'title' => '', 'example' => '', @@ -64527,123 +36170,65 @@ 'title' => '', 'example' => '', ], - 'ReferenceLBCount' => [ - 'description' => 'Number of load balancers that reference this origin pool.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'title' => '', - ], + 'ReferenceLBCount' => ['description' => 'The number of load balancers that reference this origin pool.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'Origins' => [ - 'description' => 'Information about the origins added to the origin pool.', + 'description' => 'The origins in the origin pool.', 'type' => 'array', 'items' => [ - 'description' => 'Information about the origins added to the origin pool.', + 'description' => 'An origin in the origin pool.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'Origin ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '997502094872132', - 'title' => '', - ], - 'Name' => [ - 'description' => 'Origin name.', - 'type' => 'string', - 'example' => 'origin1', - 'title' => '', - ], - 'Address' => [ - 'description' => 'Origin address, e.g., www.example.com.', - 'type' => 'string', - 'example' => 'www.example.com', - 'title' => '', - ], - 'Enabled' => [ - 'description' => 'Whether the origin is enabled:'."\n" - ."\n" - .'- true: Enabled;'."\n" - .'- false: Disabled.', - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], - 'Weight' => [ - 'description' => 'Weight, an integer between 0 and 100.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - 'title' => '', - ], - 'Type' => [ - 'description' => 'Origin type:'."\n" - .'- ip_domain: IP or domain type origin; '."\n" - .'- OSS: OSS address origin; '."\n" - .'- S3: AWS S3 origin.', - 'type' => 'string', - 'example' => 'S3', - 'title' => '', - ], - 'Header' => [ - 'description' => 'The request header to be carried during back-to-origin, only supports Host.', - 'type' => 'any', - 'example' => '{'."\n" - .' "Host": ['."\n" - .' "example.com"'."\n" - .' ]'."\n" - .' }', - 'title' => '', - ], + 'Id' => ['description' => 'The ID of the origin.', 'type' => 'integer', 'format' => 'int64', 'example' => '997502094872132', 'title' => ''], + 'Name' => ['description' => 'The name of the origin.', 'type' => 'string', 'example' => 'origin1', 'title' => ''], + 'Address' => ['description' => 'The address of the origin, such as `www.example.com`.', 'type' => 'string', 'example' => 'www.example.com', 'title' => ''], + 'Enabled' => ['description' => 'Indicates whether the origin is enabled.'."\n" + ."\n" + .'- `true`: Enabled.'."\n" + ."\n" + .'- `false`: Disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Weight' => ['description' => 'The weight of the origin, an integer from 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'Type' => ['description' => 'The type of the origin. Valid values:'."\n" + ."\n" + .'- `ip_domain`: An origin with an IP address or domain name.'."\n" + ."\n" + .'- `OSS`: An Alibaba Cloud Object Storage Service (OSS) origin.'."\n" + ."\n" + .'- `S3`: An AWS S3 origin.', 'type' => 'string', 'example' => 'S3', 'title' => ''], + 'Header' => ['description' => 'The request header to include in origin fetches. Only the `Host` header is supported.', 'type' => 'any', 'example' => '{'."\n" + .' "Host": ['."\n" + .' "example.com"'."\n" + .' ]'."\n" + .' }', 'title' => ''], 'AuthConf' => [ - 'description' => 'Authentication information. When the origin is OSS or S3 and requires authentication, you need to provide related configuration information for authentication.', + 'description' => 'The authentication configuration. This parameter is required if the origin is an OSS or AWS S3 bucket that requires authentication.', 'type' => 'object', 'properties' => [ - 'AuthType' => [ - 'description' => 'Authentication type.'."\n" - ."\n" - .'- public: Public read/write, used when the origin is OSS or S3 and it is set to public read/write;'."\n" - .'- private_same_account: Private same account, used when the origin is OSS and the authentication type is private within the same account;'."\n" - .'- private_cross_account: Private cross-account, used when the origin is OSS and the authentication type is private across accounts;'."\n" - .'- private: Used when the origin is S3 and the authentication type is private.', - 'type' => 'string', - 'example' => 'public', - 'title' => '', - ], - 'AccessKey' => [ - 'description' => 'The AccessKey required for private authentication.', - 'type' => 'string', - 'example' => 'yourAccessKeyID', - 'title' => '', - ], - 'SecretKey' => [ - 'description' => 'The SecretKey required for private authentication.', - 'type' => 'string', - 'example' => 'yourAccessKeySecret', - 'title' => '', - ], - 'Version' => [ - 'description' => 'The signature version required when the origin is AWS S3.', - 'type' => 'string', - 'example' => 'v2', - 'title' => '', - ], - 'Region' => [ - 'description' => 'The Region of the origin required when the origin is AWS S3.', - 'type' => 'string', - 'example' => 'us-east-1'."\n", - 'title' => '', - ], + 'AuthType' => ['description' => 'The authentication type. Valid values:'."\n" + ."\n" + .'- `public`: Public read/write. Use for OSS or AWS S3 origins that have public access permissions.'."\n" + ."\n" + .'- `private_same_account`: Private, same account. Use for OSS origins that use private authentication within the same account.'."\n" + ."\n" + .'- `private_cross_account`: Private, cross-account. Use for OSS origins that use private authentication from a different account.'."\n" + ."\n" + .'- `private`: Private. Use for AWS S3 origins that require private authentication.', 'type' => 'string', 'example' => 'public', 'title' => ''], + 'AccessKey' => ['description' => 'The Access Key ID required for private authentication.', 'type' => 'string', 'example' => 'yourAccessKeyID', 'title' => ''], + 'SecretKey' => ['description' => 'The Secret Access Key required for private authentication.', 'type' => 'string', 'example' => 'yourAccessKeySecret', 'title' => ''], + 'Version' => ['description' => 'The signature version. Required for AWS S3 origins.', 'type' => 'string', 'example' => 'v2', 'title' => ''], + 'Region' => ['description' => 'The region of the origin. Required for AWS S3 origins.', 'type' => 'string', 'example' => 'us-east-1'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], - 'IpVersionPolicy' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'IpVersionPolicy' => ['description' => 'The IP protocol version used for origin fetch requests. Valid values:'."\n" + ."\n" + .'- `round_robin`: Randomly selects an IPv4 or IPv6 origin.'."\n" + ."\n" + .'- `ipv4_first`: Prioritizes IPv4 origins.'."\n" + ."\n" + .'- `ipv6_first`: Prioritizes IPv6 origins.'."\n" + ."\n" + .'- `follow`: Follows the IP version used by the client.', 'type' => 'string', 'example' => 'round_robin', 'title' => ''], ], 'title' => '', 'example' => '', @@ -64658,34 +36243,10 @@ 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'description' => 'Current page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'Page size.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'Total count.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - 'title' => '', - ], - 'TotalPage' => [ - 'description' => 'Total number of pages.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of items returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of origin pools found.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'example' => '', ], @@ -64693,42 +36254,24 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'The selected location is unavailable in your plan. Change the location to one that is covered by the plan and try again.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'The selected location is unavailable in your plan. Change the location to one that is covered by the plan and try again.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], + '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\\": \\"round_robin\\"\\n }\\n ]\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 16,\\n \\"TotalPage\\": 10\\n}","type":"json"}]', 'title' => 'List Origin Pools', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListOriginPools', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOriginPools'], ], ], 'ramActions' => [ @@ -64739,25 +36282,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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', - ], + 'summary' => 'Query multiple back-to-origin rule configurations.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -64770,284 +36304,117 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257559', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can obtain the site ID by calling the [ListSites](~~ListSites~~) API operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '35281609698****', 'title' => ''], ], [ 'name' => 'ConfigType', 'in' => 'query', 'schema' => [ - 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', - 'description' => 'Configuration type, which can be used to query global or rule configurations. Value range:'."\n" - .'- global: Query global configuration.'."\n" - .'- rule: Query rule configuration.'."\n" + 'title' => '', + 'description' => 'The configuration type. You can use this parameter to query global or rule configurations. Valid values:'."\n" + .'- global: Query global configurations.'."\n" + .'- rule: Query rule configurations.'."\n" ."\n" - .'This parameter is optional; if not provided, it does not distinguish between global and rule configurations.', + .'This parameter is optional. If not specified, both global and rule configurations are returned without distinction.', + 'enumValueTitles' => ['rule' => 'Rule configuration', 'global' => 'Global configuration'], 'type' => 'string', + 'enum' => ['global', 'rule'], 'required' => false, 'example' => 'global', - 'enum' => [ - 'global', - 'rule', - ], ], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['title' => '', 'description' => 'The rule name. You do not need to set this parameter when adding a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '第几页，不传时默认为1', - 'description' => 'Page number, defaulting to 1 if not provided.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number for paginated queries. The value must be greater than or equal to 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '每页几条，最大500，不传时默认500', - 'description' => 'Number of items per page, with a maximum of 500. Defaults to 500 if not provided.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page for paginated queries. Valid values: 1 to 500. Default value: 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Version number of the site. For sites with version management enabled, this parameter can specify the version of the site for which the configuration is effective, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9'], 'Configs' => [ - 'description' => 'Response body configuration.', + 'description' => 'The configurations in the response.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '395386449776640', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'Version number of the site configuration. For sites with version management enabled, this parameter can specify the version of the site for which the configuration is effective, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'Rule execution order. The smaller the value, the higher the priority.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Value range:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, e.g., (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'example' => '(http.host eq \\"video.example.com\\")'."\n", - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'Configuration type, which can be used to query global or rule configurations. Value range:'."\n" - .'- global: Query global configuration.'."\n" - .'- rule: Query rule configuration.', - 'type' => 'string', - 'example' => 'global', - 'title' => '', - ], - 'OriginHost' => [ - 'description' => 'HOST carried in the origin request.', - 'type' => 'string', - 'example' => 'origin.example.com'."\n", - 'title' => '', - ], - 'OriginScheme' => [ - 'description' => 'Protocol used for the origin request. Value range:'."\n" - .'- http: Use HTTP protocol for origin.'."\n" - .'- https: Use HTTPS protocol for origin.'."\n" - .'- follow: Follow the client\'s protocol for origin.', - 'type' => 'string', - 'example' => 'http', - 'title' => '', - ], - 'OriginSni' => [ - 'description' => 'SNI carried in the back-to-origin request.', - 'type' => 'string', - 'example' => 'origin.example.com', - 'title' => '', - ], - 'DnsRecord' => [ - 'description' => 'Rewrite the DNS resolution record for the origin request.', - 'type' => 'string', - 'example' => 'test.example.com'."\n", - 'title' => '', - ], - 'OriginHttpPort' => [ - 'description' => 'The port of the origin server to access when using the HTTP protocol for origin requests.', - 'type' => 'string', - 'example' => '8080', - 'title' => '', - ], - 'OriginHttpsPort' => [ - 'description' => 'The port of the origin server to access when using the HTTPS protocol for origin requests.', - 'type' => 'string', - 'example' => '4433', - 'title' => '', - ], - 'Range' => [ - 'description' => 'Use range slicing to download files from the origin. Value range:'."\n" - .'- on: Enable'."\n" - .'- off: Disable'."\n" - .'- force: Force', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'OriginMtls' => [ - 'description' => 'mTLS switch. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'OriginVerify' => [ - 'description' => 'Origin certificate verification switch. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'RangeChunkSize' => [ - 'description' => 'The size of each range shard. ', - 'type' => 'string', - 'example' => '1MB', - 'title' => '', - ], - 'OriginReadTimeout' => [ - 'description' => 'Origin read timeout (in seconds). ', - 'type' => 'string', - 'example' => '10', - 'title' => '', - ], - 'Follow302Enable' => [ - 'description' => '302 redirection toggle. Valid values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Follow302MaxTries' => [ - 'description' => 'Maximum number of 302 redirects allowed. Valid values: [1–5].', - 'type' => 'string', - 'example' => '1', - 'title' => '', - ], - 'Follow302RetainArgs' => [ - 'description' => 'Toggle to retain original request parameters. Valid values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Follow302RetainHeader' => [ - 'description' => 'Toggle to retain the original request header. Valid values: '."\n" - .'- on: Enabled. '."\n" - .'- off: Disabled. ', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Follow302TargetHost' => [ - 'description' => 'Modifies the origin host after a 302 redirect. ', - 'type' => 'string', - 'example' => 'test.com', - 'title' => '', - ], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '395386449776640', 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Sequence' => ['description' => 'The execution order of the rule. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuleEnable' => ['description' => 'The rule switch. You do not need to set this parameter when adding a global configuration. Valid values:'."\n" + .'- on: Enable.'."\n" + .'- off: Disable.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'The rule content, which uses conditional expressions to match user requests. You do not need to set this parameter when adding a global configuration. There are two usage scenarios:'."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + .'- Match specified requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', 'type' => 'string', 'example' => '(http.host eq \\"video.example.com\\")'."\n", 'title' => ''], + 'RuleName' => ['description' => 'The rule name. You do not need to set this parameter when adding a global configuration.', 'type' => 'string', 'example' => 'rule_example', 'title' => ''], + 'ConfigType' => ['description' => 'The configuration type. You can query global or rule configurations based on this parameter. Valid values:'."\n" + ."\n" + .'- global: Query global configurations.'."\n" + .'- rule: Query rule configurations.', 'type' => 'string', 'example' => 'global', 'title' => ''], + 'OriginHost' => ['description' => 'The HOST carried in the back-to-origin request.', 'type' => 'string', 'example' => 'origin.example.com'."\n", 'title' => ''], + 'OriginScheme' => ['description' => 'The protocol used for back-to-origin requests. Valid values:'."\n" + .'- http: Use the HTTP protocol for back-to-origin.'."\n" + .'- https: Use the HTTPS protocol for back-to-origin.'."\n" + .'- follow: Follow the client protocol for back-to-origin.', 'type' => 'string', 'example' => 'http', 'title' => ''], + 'OriginSni' => ['description' => 'The SNI carried in the back-to-origin request.', 'type' => 'string', 'example' => 'origin.example.com', 'title' => ''], + 'DnsRecord' => ['description' => 'The rewritten DNS resolution record for back-to-origin requests.', 'type' => 'string', 'example' => 'test.example.com'."\n", 'title' => ''], + 'OriginHttpPort' => ['description' => 'The origin server port accessed when using the HTTP protocol for back-to-origin.', 'type' => 'string', 'example' => '8080', 'title' => ''], + 'OriginHttpsPort' => ['description' => 'The origin server port accessed when using the HTTPS protocol for back-to-origin.', 'type' => 'string', 'example' => '4433', 'title' => ''], + 'Range' => ['description' => 'Use range-based slicing for back-to-origin file downloads. Valid values:'."\n" + .'- on: Enable.'."\n" + .'- off: Disable.'."\n" + .'- force: Force enable.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'OriginMtls' => ['description' => 'The mTLS switch. Valid values:'."\n" + .'- on: Enable.'."\n" + .'- off: Disable.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'OriginVerify' => ['description' => 'The origin server certificate verification switch. Valid values:'."\n" + .'- on: Enable.'."\n" + .'- off: Disable.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'RangeChunkSize' => ['description' => 'The range chunk size.', 'type' => 'string', 'example' => '1MB', 'title' => ''], + 'OriginReadTimeout' => ['description' => 'The origin server read timeout period, in seconds.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'Follow302Enable' => ['description' => 'The back-to-origin 302 redirect follow switch. Valid values:'."\n" + .'- on: Enable.'."\n" + .'- off: Disable.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Follow302MaxTries' => ['description' => 'The maximum number of 302 redirect follows. Valid values: 1 to 5.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Follow302RetainArgs' => ['description' => 'The switch for retaining original request parameters. Valid values:'."\n" + .'- on: Enable.'."\n" + .'- off: Disable.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Follow302RetainHeader' => ['description' => 'The switch for retaining original request headers. Valid values:'."\n" + .'- on: Enable.'."\n" + .'- off: Disable.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Follow302TargetHost' => ['description' => 'The back-to-origin host after 302 redirect modification.', 'type' => 'string', 'example' => 'test.com', 'title' => ''], ], 'description' => '', 'title' => '', @@ -65056,34 +36423,10 @@ 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'description' => 'Current page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'Page size.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'Total number of records.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - 'title' => '', - ], - 'TotalPage' => [ - 'description' => 'Total number of pages.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - 'title' => '', - ], + 'PageNumber' => ['description' => 'The current page number, same as the PageNumber request parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], 'example' => '', ], @@ -65091,46 +36434,21 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], ], ], - 'title' => 'List of Origin Rule Configurations for Sites', - 'summary' => 'Query multiple origin rule configurations', + '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"}]', + 'title' => 'Query the list of site back-to-origin rule configurations', 'changeSet' => [ - [ - 'createdAt' => '2025-04-17T08:47:33.000Z', - 'description' => 'Response parameters changed', - ], - [ - 'createdAt' => '2025-04-01T01:57:04.000Z', - 'description' => 'Response parameters changed', - ], - [ - 'createdAt' => '2025-03-20T05:57:46.000Z', - 'description' => 'Response parameters changed', - ], - [ - 'createdAt' => '2025-02-27T09:16:40.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-04-17T08:47:33.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-04-01T01:57:04.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-03-20T05:57:46.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-02-27T09:16:40.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListOriginRules', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOriginRules'], ], ], 'ramActions' => [ @@ -65141,27 +36459,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => 'Lists all custom response pages created by the User. This API provides paging functionality and supports retrieving the response page list based on page number and page size. ', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Lists all custom response pages created by the user. This operation supports pagination and allows you to retrieve the response page list by specifying the page number and page size.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -65174,9 +36481,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239580', - 'abilityTreeNodes' => [ - 'FEATUREdcdnL8HX1L', - ], + 'abilityTreeNodes' => ['FEATUREdcdnL8HX1L'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ @@ -65185,16 +36490,13 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'Query parameters passed in JSON format, containing various filter conditions.', + 'description' => 'The query parameters passed in JSON format, which contain various filter conditions.', 'type' => 'object', 'properties' => [ - 'NameDescriptionLike' => [ - 'description' => 'Perform a fuzzy query on the name or description of custom pages.', - 'type' => 'string', - 'required' => false, - 'example' => 'example', - 'title' => '', - ], + 'NameDescriptionLike' => ['description' => 'The keyword used for fuzzy matching against the name or description of custom pages.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], + 'ContentType' => ['title' => '', 'description' => 'The Content-Type field in the HTTP header. Example values:'."\n" + .'* text/html'."\n" + .'* application/json', 'type' => 'string', 'example' => 'application/json', 'required' => false], ], 'required' => false, 'title' => '', @@ -65204,136 +36506,51 @@ [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The page number. Valid values: **1 to 100000**. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number. Valid values: **1 to 100000**. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The number of entries per page. Default value: 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], - 'Usage' => [ - 'title' => '', - 'description' => 'The number of custom error pages that you created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => '', - 'description' => 'The number of custom error pages after filtering.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], + 'Usage' => ['title' => '', 'description' => 'The number of custom response pages created by the user.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'TotalCount' => ['title' => '', 'description' => 'The number of custom response pages after filtering.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'Pages' => [ 'title' => '', - 'description' => 'The custom error pages. Each element in the array contains error page-specific information.'."\n", + 'description' => 'The array of custom response pages. Each object in the array contains the details of a page.', 'type' => 'array', 'items' => [ - 'title' => 'WafPageItemType', - 'description' => 'WafPageItemType'."\n", + 'title' => '', + 'description' => 'WafPageItemType', 'type' => 'object', 'properties' => [ - 'UpdateTime' => [ - 'title' => '', - 'description' => 'The time when the custom error page was last modified.'."\n", - 'type' => 'string', - 'example' => '2024-01-01T00:00:00Z', - ], - 'Id' => [ - 'title' => '', - 'description' => 'The ID of the custom error page.[](~~2850223~~)'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50000001', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The name of the custom error page.'."\n", - 'type' => 'string', - 'example' => 'example', - ], - 'Kind' => [ - 'title' => '', - 'description' => 'The type of the custom error page.'."\n", - 'type' => 'string', - 'example' => 'custom', - ], - 'Description' => [ - 'title' => '', - 'description' => 'The description of the custom error page.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a custom deny page', - 'maxLength' => 1024, - 'pattern' => '', - 'default' => '', - ], - 'ContentType' => [ - 'title' => '', - 'description' => 'The Content-Type field in the HTTP header.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'text/html', - 'pattern' => '', - 'default' => '', - ], - 'Content' => [ - 'title' => '', - 'description' => 'The Base64-encoded content of the error page. The content type is specified by the Content-Type field.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=', - 'pattern' => '', - 'default' => '', - ], + 'UpdateTime' => ['title' => '', 'description' => 'The time when the custom response page was last modified.'."\n" + ."\n" + .'Format: RFC 3339 / ISO 8601, UTC time zone (ending with Z).'."\n" + ."\n" + .'Example: 2026-06-10T14:23:45Z', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], + 'Id' => ['title' => '', 'description' => 'The ID of the custom response page. You can call the [ListPages](~~2850223~~) operation to obtain the ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '50000001'], + 'Name' => ['title' => '', 'description' => 'The name of the custom response page.', 'type' => 'string', 'example' => 'example'], + 'Kind' => ['title' => '', 'description' => 'The type of the custom response page.', 'type' => 'string', 'example' => 'custom'], + 'Description' => ['title' => '', 'description' => 'The description of the custom response page.', 'type' => 'string', 'required' => false, 'example' => 'a custom deny page', 'maxLength' => 1024, 'pattern' => '', 'default' => ''], + 'ContentType' => ['title' => '', 'description' => 'The Content-Type field in the HTTP header.', 'type' => 'string', 'required' => true, 'example' => 'text/html', 'pattern' => '', 'default' => ''], + 'Content' => ['title' => '', 'description' => 'The Base64-encoded response page content corresponding to the Content-Type.', 'type' => 'string', 'required' => true, 'example' => 'PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=', 'pattern' => '', 'default' => ''], ], 'example' => '', ], 'example' => '', ], - 'PageNumber' => [ - 'title' => '', - 'description' => 'The page number returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], + 'PageNumber' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], ], 'example' => '', ], @@ -65341,44 +36558,21 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'List Custom Response Pages', + 'staticInfo' => ['returnType' => 'synchronous'], + '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"}]', + 'title' => 'List custom response pages', 'changeSet' => [ - [ - 'createdAt' => '2025-01-09T06:24:33.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-09-25T07:02:48.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T06:56:37.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-01-09T06:24:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-25T07:02:48.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T06:56:37.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListPages', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPages'], ], ], 'ramActions' => [ @@ -65389,25 +36583,16 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', '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', - ], + 'ListPostpaidRatePlanInstances' => [ + 'summary' => 'Queries the list of pay-as-you-go plan instances.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -65416,129 +36601,108 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '239634', - 'abilityTreeNodes' => [ - 'FEATUREdcdnVFT29S', - ], + 'abilityTreeCode' => '239352', + 'abilityTreeNodes' => ['FEATUREdcdnZA9EPX'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'SiteId', + 'name' => 'CheckRemainingSiteQuota', 'in' => 'query', 'schema' => [ - 'description' => 'The site ID. You can obtain this by invoking the [ListSites](~~2850189~~) API. ', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', + 'description' => 'Specifies whether to check for remaining site quota. Valid values:'."\n" + ."\n" + .'- true: Queries instances that have remaining site quota.'."\n" + ."\n" + .'- false: Does not filter by this condition.', + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => ['true', 'false'], + 'required' => false, + 'example' => 'true', 'title' => '', ], ], [ - 'name' => 'RecordName', + 'name' => 'SortBy', 'in' => 'query', + 'allowEmptyValue' => false, 'schema' => [ - 'description' => 'The record name. This is used as a filter condition for the query. ', + 'description' => 'The field by which to sort the results. Valid values:'."\n" + ."\n" + .'- CreateTime: sorts by creation time.', + 'enumValueTitles' => ['CreateTime' => 'Sorts by creation time.'], 'type' => 'string', + 'enum' => ['CreateTime', 'default'], 'required' => false, - 'example' => 'www.example.com', + 'example' => 'CreateTime', 'title' => '', ], ], [ - 'name' => 'RecordMatchType', + 'name' => 'SortOrder', 'in' => 'query', 'schema' => [ - 'description' => 'The search matching pattern for the record name. The default value is exact match. Valid values: '."\n" - .'- **prefix**: prefix match. '."\n" - .'- **suffix**: suffix match. '."\n" - .'- **exact**: exact match. '."\n" - .'- **fuzzy**: fuzzy match. ', + 'title' => '', + 'description' => 'The sort order. Valid values:'."\n" + ."\n" + .' * asc: ascending order'."\n" + ."\n" + .' * desc: descending order.', + 'enumValueTitles' => ['asc' => 'ascending order.', 'desc' => 'descending order.'], 'type' => 'string', + 'enum' => ['asc', 'desc'], 'required' => false, - 'example' => 'fuzzy', - 'title' => '', + 'example' => 'desc', ], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'Page number. Default Value: **1**.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number for paging. The value must be greater than or equal to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Page size. Default Value: **500**.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'title' => '', - ], - ], - [ - 'name' => 'SourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The origin server type of the record, used as a filter condition for queries (only CNAME records can be filtered by this field). Valid values:'."\n" - .'- **OSS**: OSS origin server.'."\n" - .'- **S3**: S3 origin server.'."\n" - .'- **LB**: Server Load Balancer origin server.'."\n" - .'- **OP**: Address pool origin server.'."\n" - .'- **Domain**: Standard domain name origin server.', - 'type' => 'string', - 'required' => false, - 'example' => 'OSS', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries per page for paging. Valid values: 1 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '12', 'title' => ''], ], [ - 'name' => 'BizName', + 'name' => 'Status', 'in' => 'query', 'schema' => [ - 'description' => 'The business scenario for record acceleration, used as a filter condition for queries. Valid values:'."\n" - .'- **image_video**: Image and Video.'."\n" - .'- **api**: API.'."\n" - .'- **web**: Web page.', + 'description' => 'The instance status. Valid values:'."\n" + ."\n" + .' * online: Normal.'."\n" + ."\n" + .' * overdue: Overdue payment.'."\n" + ."\n" + .' * disable: Released.', + 'enumValueTitles' => ['overdue' => 'Overdue payment.', 'disable' => 'Released.', 'online' => 'Normal.'], 'type' => 'string', + 'enum' => ['online', 'overdue', 'disable'], 'required' => false, - 'example' => 'web', + 'example' => 'online', 'title' => '', ], ], [ - 'name' => 'Proxied', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Indicates whether proxy acceleration is enabled for the record, used as a filter condition for queries. Valid values:'."\n" - ."\n" - .'- **true**: Enables proxy.'."\n" - .'- **false**: Disables proxy acceleration.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], + 'schema' => ['description' => 'The instance ID. Use this parameter to query a specific instance.', 'type' => 'string', 'required' => false, 'example' => 'sp-dps-xxxxxx', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'UnrelatedType', 'in' => 'query', 'schema' => [ - 'description' => 'The DNS record type of the record, used as a filter condition for queries.', + 'description' => 'Specifies whether the instance has purchased additional bot or DDoS protection.', + 'enumValueTitles' => ['bot' => 'Bot protection.', 'ddos' => 'DDoS protection.'], 'type' => 'string', + 'enum' => ['bot', 'ddos'], 'required' => false, - 'example' => 'CNAME', + 'example' => 'bot', 'title' => '', ], ], @@ -65546,309 +36710,284 @@ 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response information.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - ], - 'PageNumber' => [ - 'description' => 'Current page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'Number of records displayed per page.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'Total number of records.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], - 'Records' => [ - 'description' => 'DNS information of the records. For details, see [Documentation](~~2708761~~)[Documentation](https://www.alibabacloud.com/help/doc-detail/2708761.html).', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A123425345'], + 'InstanceInfo' => [ + 'description' => 'The list of instance information.', 'type' => 'array', 'items' => [ - 'description' => 'Information of a single record.', + 'description' => 'The details of a plan instance.', 'type' => 'object', 'properties' => [ - 'BizName' => [ - 'description' => 'The business scenario for record acceleration. Valid values:'."\n" - .'- **image_video**: Image and video.'."\n" - .'- **api**: API.'."\n" - .'- **web**: Web page.', - 'type' => 'string', - 'example' => 'web', - 'title' => '', - ], - 'Data' => [ - 'description' => 'The specific DNS information of the record. Different record types contain different information. ', - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The record value or partial content. This parameter is present in A/AAAA, CNAME, NS, MX, TXT, CAA, SRV, and URI records, and has different meanings depending on the record type:'."\n" + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'sp-xcdn-96wblslz****', 'title' => ''], + 'PlanName' => ['description' => 'The plan name in English.', 'type' => 'string', 'example' => 'basic', 'title' => ''], + 'PlanType' => ['description' => 'The plan type of the instance. Valid values:'."\n" + .'- normal: Fixed plan.'."\n" + .'- enterprise: Enterprise plan.', 'type' => 'string', 'example' => 'normal', 'title' => ''], + 'SiteQuota' => ['description' => 'The site quota.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the instance was created. The value is in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2026-04-19T11:15:20Z', 'title' => ''], + 'Sites' => [ + 'description' => 'The list of sites.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of sites that are associated with the plan instance.', + 'type' => 'object', + 'properties' => [ + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456****', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'SiteStatus' => ['description' => 'The site status. Valid values:'."\n" ."\n" - .'- **A/AAAA**: The IP address pointed to. When multiple IP addresses are specified, they must be separated by commas (`,`). At least one IPv4 address is required.'."\n" - .'- **CNAME**: The target domain name pointed to.'."\n" - .'- **NS**: The name server designated for the domain.'."\n" - .'- **MX**: A valid target mail server domain name.'."\n" - .'- **TXT**: A valid text string.'."\n" - .'- **CAA**: A valid certification authority domain name.'."\n" - .'- **SRV**: A valid target host domain name.'."\n" - .'- **URI**: A valid URI string. ', - 'type' => 'string', - 'example' => 'CNAME', - 'title' => '', - ], - 'Priority' => [ - 'description' => 'The priority of the record, ranging from **0** to **65535**. A smaller numeric value indicates a higher priority. Exclusive to MX, SRV, and URI records. ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Flag' => [ - 'description' => 'The flag of the record. For CAA records, the flag indicates its priority and processing method, with a range of **0** to **255**. Exclusive to CAA records. ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '128', - 'title' => '', - ], - 'Tags' => [ - 'type' => 'object', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'Weight' => [ - 'description' => 'The weight of the record, ranging from **0** to **65535**. Exclusive to SRV and URI records.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Port' => [ - 'description' => 'The port of the record, ranging from **0** to **65535**. Exclusive to SRV records. ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The certificate type (for CERT records) or public key type (for SSHFP records). ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'KeyTag' => [ - 'description' => 'The public key identity of the record, with a range of **0~65535**. This field is exclusive to CERT records. ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Algorithm' => [ - 'description' => 'The encryption algorithm used by the record, ranging from **0** to **255**. Exclusive to CERT and SSHFP records. ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Certificate' => [ - 'description' => 'The public key certificate information of the record. This field is exclusive to CERT, SMIMEA, and TLSA records. ', - 'type' => 'string', - 'example' => 'dGVzdGFkYWxrcw==', - 'title' => '', - ], - 'Usage' => [ - 'description' => 'The usage identity of the record, ranging from **0** to **255**. Exclusive to SMIMEA and TLSA records. ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Selector' => [ - 'description' => 'The type of certificate or public key used by the record, with a range of **0~255**. This field is exclusive to SMIMEA and TLSA records. ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'MatchingType' => [ - 'description' => 'The algorithm policy used by the record to match or authenticate certificates, with a range of **0~255**. This field is exclusive to SMIMEA and TLSA records. ', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Fingerprint' => [ - 'description' => 'The public key fingerprint value of the record. Exclusive to SSHFP records. ', - 'type' => 'string', - 'example' => 'abcdef1234567890', - 'title' => '', - ], - 'Tag' => [ - 'description' => 'The label of the record. For CAA records, the tag indicates its specific type and purpose. This field is exclusive to CAA records. ', - 'type' => 'string', - 'example' => 'issue', - 'title' => '', + .'- pending: The site is pending configuration.'."\n" + .'- active: The site is activated.'."\n" + .'- offline: The site is offline.'."\n" + .'- moved: The site has been replaced.', 'type' => 'string', 'example' => 'pending', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'example' => '{"value":"1.1.1.1"}', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The creation time of the record, formatted according to ISO 8601 notation and expressed in UTC, with the format yyyy-MM-ddTHH:mm:ssZ. ', - 'type' => 'string', - 'example' => '2023-12-24T02:01:11Z', - 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'The update time of the record, formatted according to ISO 8601 notation in UTC, with the format yyyy-MM-ddTHH:mm:ssZ.', - 'type' => 'string', - 'example' => '2023-06-07T10:02:59Z', - 'title' => '', - ], - 'Proxied' => [ - 'description' => 'Indicates whether proxy acceleration is enabled for the record. Valid values:'."\n" - ."\n" - .'- **true**: Proxy acceleration is enabled.'."\n" - .'- **false**: Proxy acceleration is disabled.', - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], - 'RecordId' => [ - 'description' => 'The record ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567890123', - 'title' => '', - ], - 'RecordSourceType' => [ - 'description' => 'Source type for CNAME records. This parameter must be specified when adding a CNAME record. Valid values:'."\n" - ."\n" - .'- **OSS**: OSS source.'."\n" - .'- **S3**: S3 source.'."\n" - .'- **LB**: Server Load Balancer source.'."\n" - .'- **OP**: Address pool source.'."\n" - .'- **Domain**: Standard domain name source.'."\n" - ."\n" - .'If this parameter is not provided or is empty, it defaults to Domain, indicating a standard domain name source.', - 'type' => 'string', - 'example' => 'OSS', - 'title' => '', - ], - 'RecordName' => [ - 'description' => 'Record name.', - 'type' => 'string', - 'example' => 'a.example.com', - 'title' => '', - ], - 'RecordType' => [ - 'description' => 'The DNS record type, such as **A/AAAA**, **CNAME**, or **TXT**.', - 'type' => 'string', - 'example' => 'A/AAAA', - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'ID of the site to which the record belongs.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567890123', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'Name of the site to which the record belongs.', - 'type' => 'string', - 'example' => 'example.com', - 'title' => '', - ], - 'Ttl' => [ - 'description' => 'The record\'s time-to-live (TTL), in seconds. A value of 1 indicates that the TTL is set automatically.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - 'title' => '', - ], - 'RecordCname' => [ - 'description' => 'The canonical name (CNAME) of the record. When the site\'s connection type is CNAME, you must configure a CNAME value for the record. ', - 'type' => 'string', - 'example' => 'a.example.com.cnamezone.com', 'title' => '', + 'example' => '', ], - 'Comment' => [ - 'description' => 'Comment for the record.', - 'type' => 'string', - 'example' => 'this is a remark.', + 'Status' => ['description' => 'The instance status.', 'type' => 'string', 'example' => 'online', 'title' => ''], + 'Coverages' => ['description' => 'The acceleration regions to which the instance can bindable sites. Multiple values are separated by commas (,). Valid values:'."\n" + ."\n" + .'- domestic: the Chinese mainland.'."\n" + .'- overseas: global (excluding the Chinese mainland).'."\n" + .'- global: global (including the Chinese mainland).', 'type' => 'string', 'example' => 'domestic', 'title' => ''], + 'BillingMethod' => ['description' => 'The billable methods. Valid values:'."\n" + .'- dps_month95: monthly 95th percentile billing.', 'type' => 'string', 'example' => 'SUBSCRIBE', 'title' => ''], + 'PlanNameCn' => ['description' => 'The plan name in Chinese.', 'type' => 'string', 'example' => '测试套餐', 'title' => ''], + 'BillingMode' => ['description' => 'The billing mode. Valid values:'."\n" + ."\n" + .' * POSTPAY: pay-as-you-go.', 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''], + 'ExpectedUpdateTime' => ['description' => 'The scheduled specification change time. The value is in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2026-04-19T11:15:20Z', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'PageNumber' => ['description' => 'The current page number, which is the same as the PageNumber request parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A123425345\\",\\n \\"InstanceInfo\\": [\\n {\\n \\"InstanceId\\": \\"sp-xcdn-96wblslz****\\",\\n \\"PlanName\\": \\"basic\\",\\n \\"PlanType\\": \\"normal\\",\\n \\"SiteQuota\\": \\"1\\",\\n \\"CreateTime\\": \\"2026-04-19T11:15:20Z\\",\\n \\"Sites\\": [\\n {\\n \\"SiteId\\": 0,\\n \\"SiteName\\": \\"example.com\\",\\n \\"SiteStatus\\": \\"pending\\"\\n }\\n ],\\n \\"Status\\": \\"online\\",\\n \\"Coverages\\": \\"domestic\\",\\n \\"BillingMethod\\": \\"SUBSCRIBE\\",\\n \\"PlanNameCn\\": \\"测试套餐\\",\\n \\"BillingMode\\": \\"POSTPAY\\",\\n \\"ExpectedUpdateTime\\": \\"2026-04-19T11:15:20Z\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"TotalPage\\": 2\\n}","type":"json"}]', + 'title' => 'Query pay-as-you-go plan instances for sites', + 'description' => 'Queries the list of pay-as-you-go plan instances under your account. You can filter and sort the results by multiple conditions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListPostpaidRatePlanInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListRecords' => [ + 'summary' => 'Queries the list of DNS records under a site, including record values, priorities, authentication configurations, etc. Supports filtering by conditions such as record name and record type.', + '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' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], + ], + [ + 'name' => 'RecordName', + 'in' => 'query', + 'schema' => ['description' => 'Record name. Used as a filter condition for queries.', 'type' => 'string', 'required' => false, 'example' => 'www.example.com', 'title' => ''], + ], + [ + 'name' => 'RecordMatchType', + 'in' => 'query', + 'schema' => ['description' => 'The search matching mode for record names. Defaults to exact match. Valid values:'."\n" + ."\n" + .'- **prefix**: Prefix match.'."\n" + .'- **suffix**: Suffix match.'."\n" + .'- **exact**: Exact match.'."\n" + .'- **fuzzy**: Fuzzy match.', 'type' => 'string', 'required' => false, 'example' => 'fuzzy', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number for paginated queries. The value must be greater than or equal to 1. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page for paginated queries. Valid values: 1 to 500. Default value: **500**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => ['description' => 'The origin type of the record. Used as a filter condition for queries (only CNAME records can be filtered by this field). Valid values:'."\n" + .'- **OSS**: OSS origin.'."\n" + .'- **S3**: S3 origin.'."\n" + .'- **LB**: Load balancer origin.'."\n" + .'- **OP**: Origin pool.'."\n" + .'- **Domain**: Standard domain origin.', 'type' => 'string', 'required' => false, 'example' => 'OSS', 'title' => ''], + ], + [ + 'name' => 'BizName', + 'in' => 'query', + 'schema' => ['description' => 'The business scenario for record acceleration. Used as a filter condition for queries. Valid values:'."\n" + .'- **image_video**: Image and video.'."\n" + .'- **api**: API.'."\n" + .'- **web**: Web page.', 'type' => 'string', 'required' => false, 'example' => 'web', 'title' => ''], + ], + [ + 'name' => 'Proxied', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether proxy acceleration is enabled for the record. Used as a filter condition for queries. Valid values:'."\n" + ."\n" + .'- **true**: Proxy enabled.'."\n" + .'- **false**: Proxy acceleration disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => 'The DNS record type of the record. Used as a filter condition for queries.', 'type' => 'string', 'required' => false, 'example' => 'CNAME', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74'], + 'PageNumber' => ['description' => 'The current page number, same as the PageNumber request parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of records displayed per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Records' => [ + 'description' => 'DNS information of the records. For details, refer to [Documentation](~~2708761~~)[Documentation](https://www.alibabacloud.com/help/doc-detail/2708761.html).', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about a single record.', + 'type' => 'object', + 'properties' => [ + 'BizName' => ['description' => 'The business scenario for record acceleration. Valid values:'."\n" + .'- **image_video**: Image and video.'."\n" + .'- **api**: API.'."\n" + .'- **web**: Web page.', 'type' => 'string', 'example' => 'web', 'title' => ''], + 'Data' => [ + 'description' => 'The specific DNS information of the record. Different record types contain different information.', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The record value or partial content. This parameter is included in A/AAAA, CNAME, NS, MX, TXT, CAA, SRV, and URI records. It has different meanings for different record types:'."\n" + ."\n" + .'- **A/AAAA**: The IP address pointed to. When there are multiple IPs, they are separated by commas (,). At least one IPv4 address is required.'."\n" + .'- **CNAME**: The target domain name pointed to.'."\n" + .'- **NS**: The name server for the specified domain.'."\n" + .'- **MX**: A valid target mail server domain name.'."\n" + .'- **TXT**: A valid text string.'."\n" + .'- **CAA**: A valid certificate authority domain name.'."\n" + .'- **SRV**: A valid target host domain name.'."\n" + .'- **URI**: A valid URI string.', 'type' => 'string', 'example' => 'CNAME', 'title' => ''], + 'Priority' => ['description' => 'The priority of the record. Valid values: **0 to 65535**. A smaller value indicates a higher priority. Exclusive to MX, SRV, and URI records.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Flag' => ['description' => 'The flag of the record. The Flag of a CAA record indicates its priority and processing method. Valid values: **0 to 255**. Exclusive to CAA records.', 'type' => 'integer', 'format' => 'int32', 'example' => '128', 'title' => ''], + 'Tags' => ['description' => 'The tags of the record.', 'type' => 'object', 'example' => '{\\"Name\\":\\"PARAMETER\\"}', 'title' => ''], + 'Weight' => ['description' => 'The weight of the record. Valid values: **0 to 65535**. Exclusive to SRV and URI records.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Port' => ['description' => 'The port of the record. Valid values: **0 to 65535**. Exclusive to SRV records.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'Type' => ['description' => 'The certificate type of the record (in CERT records), or the public key type (in SSHFP records).', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'KeyTag' => ['description' => 'The public key identifier of the record. Valid values: **0 to 65535**. Exclusive to CERT records.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Algorithm' => ['description' => 'The encryption algorithm used by the record. Valid values: **0 to 255**. Exclusive to CERT and SSHFP records.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Certificate' => ['description' => 'The public key certificate information of the record. Exclusive to CERT, SMIMEA, and TLSA records.', 'type' => 'string', 'example' => 'dGVzdGFkYWxrcw==', 'title' => ''], + 'Usage' => ['description' => 'The usage identifier of the record. Valid values: **0 to 255**. Exclusive to SMIMEA and TLSA records.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Selector' => ['description' => 'The type of certificate or public key used by the record. Valid values: **0 to 255**. Exclusive to SMIMEA and TLSA records.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'MatchingType' => ['description' => 'The algorithm strategy used by the record for matching or verifying certificates. Valid values: **0 to 255**. Exclusive to SMIMEA and TLSA records.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Fingerprint' => ['description' => 'The public key fingerprint value of the record. Exclusive to SSHFP records.', 'type' => 'string', 'example' => 'abcdef1234567890', 'title' => ''], + 'Tag' => ['description' => 'The tag of the record. The Tag of a CAA record indicates its specific type and purpose. Exclusive to CAA records.', 'type' => 'string', 'example' => 'issue', 'title' => ''], + ], + 'example' => '{"value":"1.1.1.1"}', 'title' => '', ], + 'CreateTime' => ['description' => 'The creation time of the record. The date format follows the ISO 8601 standard and uses UTC time in the format of yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2023-12-24T02:01:11Z', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time of the record. The date format follows the ISO 8601 standard and uses UTC time in the format of yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2023-06-07T10:02:59Z', 'title' => ''], + 'Proxied' => ['description' => 'Indicates whether proxy acceleration is enabled for the record. Valid values:'."\n" + ."\n" + .'- **true**: Proxy enabled.'."\n" + .'- **false**: Proxy acceleration disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RecordId' => ['description' => 'The record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''], + 'RecordSourceType' => ['description' => 'The origin type of the CNAME record. This parameter is required when adding a CNAME record. Valid values:'."\n" + ."\n" + .'- **OSS**: OSS origin.'."\n" + .'- **S3**: S3 origin.'."\n" + .'- **LB**: Load balancer origin.'."\n" + .'- **OP**: Origin pool.'."\n" + .'- **Domain**: Standard domain origin.'."\n" + ."\n" + .'If this parameter is not specified or left empty, the default value is Domain, which indicates a standard domain origin type.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], + 'RecordName' => ['description' => 'The record name.', 'type' => 'string', 'example' => 'a.example.com', 'title' => ''], + 'RecordType' => ['description' => 'The DNS type of the record, such as **A/AAAA, CNAME, TXT**, etc.', 'type' => 'string', 'example' => 'A/AAAA', 'title' => ''], + 'SiteId' => ['description' => 'The ID of the site to which the record belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''], + 'SiteName' => ['description' => 'The name of the site to which the record belongs.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'Ttl' => ['description' => 'The TTL (Time to Live) of the record, in seconds. When the value is 1, it indicates that the TTL is set to automatic.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'RecordCname' => ['description' => 'The CNAME of the record. This is the CNAME value that needs to be configured for the record when the site access method is CNAME access.', 'type' => 'string', 'example' => 'a.example.com.cnamezone.com', 'title' => ''], + 'Comment' => ['description' => 'The comment of the record.', 'type' => 'string', 'example' => 'this is a remark.', 'title' => ''], 'AuthConf' => [ - 'description' => 'Authentication information for the origin server of the CNAME record.', + 'description' => 'The origin authentication information of the CNAME record.', 'type' => 'object', 'properties' => [ - 'AuthType' => [ - 'description' => 'The origin authentication type. The supported authentication types vary depending on the origin type. The origin type refers to the SourceType parameter in this API. When the origin type is OSS or S3, you must specify the origin authentication type. Valid values: '."\n" - .'- **public**: public-read. Use this value when the origin type is OSS or S3 and the origin is publicly readable. '."\n" - .'- **private**: private read. Use this value when the origin type is S3 and the origin is privately readable. '."\n" - .'- **private_same_account**: private read within the same Alibaba Cloud account. Use this value when the origin type is OSS, the origin is privately readable, and it belongs to the same Alibaba Cloud account. '."\n" - .'- **private_cross_account**: private read across different Alibaba Cloud accounts. Use this value when the origin type is OSS, the origin is privately readable, and it belongs to a different Alibaba Cloud account. ', - 'type' => 'string', - 'example' => 'private', - 'title' => '', - ], - 'AccessKey' => [ - 'description' => 'The AccessKey of the account to which the origin belongs. This parameter is required when the origin type is OSS and the origin authentication type is private read across different Alibaba Cloud accounts, or when the origin type is S3 and the origin authentication type is private read. ', - 'type' => 'string', - 'example' => 'u0Nkg5gBK***QF5wvKMM504JUHt', - 'title' => '', - ], - 'SecretKey' => [ - 'description' => 'The SecretKey of the account to which the origin server belongs. This parameter is required when the origin server type is OSS and the authentication type is private cross-account read, or when the origin server type is S3 and the authentication type is private read.', - 'type' => 'string', - 'example' => 'VIxuvJSA2S03f***kp208dy5w7', - 'title' => '', - ], - 'Version' => [ - 'description' => 'The signature algorithm version. This parameter is required when the origin type is S3 and the origin authentication type is private read. The following versions are supported: '."\n" - .'- **v2** '."\n" - .'- **v4** '."\n" - ."\n" - .'If this parameter is not specified, the default value is v4. ', - 'type' => 'string', - 'example' => 'v4', - 'title' => '', - ], - 'Region' => [ - 'description' => 'The region where the origin is located. This parameter is required when the origin type is S3. You can obtain the region of the origin from the official S3 website. ', - 'type' => 'string', - 'example' => 'us-east-1', - 'title' => '', - ], + 'AuthType' => ['description' => 'The origin authentication type. Different origin types support different authentication types. The origin type refers to the SourceType parameter in this API. When the origin type is OSS or S3, the origin authentication type must be specified. Valid values:'."\n" + .'- **public**: Public read. Use this value when the origin type is OSS or S3 and the origin has public read access.'."\n" + .'- **private**: Private read. Use this value when the origin type is S3 and the origin has private read access.'."\n" + .'- **private_same_account**: Private same-account read. Use this value when the origin type is OSS, the origin is under the same Alibaba Cloud account, and the origin has private read access.'."\n" + .'- **private_cross_account**: Private cross-account read. Use this value when the origin type is OSS, the origin is not under the same Alibaba Cloud account, and the origin has private read access.', 'type' => 'string', 'example' => 'private', 'title' => ''], + 'AccessKey' => ['description' => 'The AccessKey of the account to which the origin belongs. This parameter is available when the origin type is OSS with private cross-account read authentication, or when the origin type is S3 with private read authentication.', 'type' => 'string', 'example' => 'u0Nkg5gBK***QF5wvKMM504JUHt', 'title' => ''], + 'SecretKey' => ['description' => 'The SecretKey of the account to which the origin belongs. This parameter is available when the origin type is OSS with private cross-account read authentication, or when the origin type is S3 with private read authentication.', 'type' => 'string', 'example' => 'VIxuvJSA2S03f***kp208dy5w7', 'title' => ''], + 'Version' => ['description' => 'The signature algorithm version. This parameter is available when the origin type is S3 and the origin authentication type is private read. Valid values:'."\n" + .'- **v2**'."\n" + .'- **v4**'."\n" + ."\n" + .'Default value: v4.', 'type' => 'string', 'example' => 'v4', 'title' => ''], + 'Region' => ['description' => 'The region where the origin is located. This parameter is available when the origin type is S3. The region of the origin can be obtained from the official S3 website.', 'type' => 'string', 'example' => 'us-east-1', 'title' => ''], ], 'title' => '', 'example' => '', ], - 'HostPolicy' => [ - 'description' => 'The origin fetch HOST policy, which takes effect only for CNAME records. This policy determines the HOST header used during origin fetch. Valid modes:'."\n" - ."\n" - .'- **follow_hostname**: Use the request HOST.'."\n" - .'- **follow_origin_domain**: Use the origin domain name.', - 'type' => 'string', - 'example' => 'follow_origin_domain', - 'title' => '', - ], + 'HostPolicy' => ['description' => 'The origin host policy. This takes effect when the record type is CNAME. It sets the policy for the host header used during origin requests. Two modes are available:'."\n" + ."\n" + .'- **follow_hostname**: Follow the request host.'."\n" + .'- **follow_origin_domain**: Follow the origin domain.', 'type' => 'string', 'example' => 'follow_origin_domain', 'title' => ''], ], 'title' => '', 'example' => '', @@ -65865,38 +37004,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'title' => 'Query DNS record list ', - 'summary' => 'Query the list of DNS records under a site, including record values, priority, authentication configuration, and more. Filtering by conditions such as record name and record type is supported.', - 'description' => 'DNS records corresponding to Edge Container, Edge Routine, and Layer 4 acceleration will not be returned by this API.', + '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"}]', + 'title' => 'Query DNS Record List', + 'description' => 'DNS records corresponding to edge containers, edge functions, and Layer 4 acceleration will not be returned by this API.', 'changeSet' => [ - [ - 'createdAt' => '2025-08-21T09:39:51.000Z', - 'description' => 'Response parameters changed', - ], - [ - 'createdAt' => '2024-11-19T01:42:00.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-09-23T08:53:22.000Z', - 'description' => 'Error codes changed, Response parameters changed', - ], + ['createdAt' => '2025-08-21T09:39:51.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-19T01:42:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-23T08:53:22.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListRecords', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRecords'], ], ], 'ramActions' => [ @@ -65907,235 +37028,119 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => [ - 'summary' => 'Query Redirect Rule List', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the redirect configuration list of a site.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257660', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456******', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456******', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '35281609698****', 'title' => ''], ], [ 'name' => 'ConfigType', 'in' => 'query', 'schema' => [ - 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', - 'description' => 'Configuration type. Possible values:'."\n" - .'- global: Global configuration.'."\n" - .'- rule: Rule configuration.', + 'title' => '', + 'description' => 'The configuration type. Valid values:'."\n" + .'- global: global configuration.'."\n" + .'- rule: rule configuration.', + 'enumValueTitles' => ['rule' => 'Rule configuration.', 'global' => 'Global configuration.'], 'type' => 'string', + 'enum' => ['global', 'rule'], 'required' => false, 'example' => 'rule', - 'enum' => [ - 'global', - 'rule', - ], ], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', - 'description' => 'Rule name, which can be used to find the rule with the specified name.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - ], + 'schema' => ['title' => '', 'description' => 'The rule name. You can use this parameter to query the rule whose name matches the specified value.', 'type' => 'string', 'required' => false, 'example' => 'rule_example'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '第几页，不传时默认为1', - 'description' => 'Page number.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number for a paged query. The value must be greater than or equal to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '每页几条，最大500，不传时默认500', - 'description' => 'Page size, default is **500**, and the value range is **1~500**.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page for a paged query. Valid values: 1 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the effective version of the site configuration, with the default being version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Request response result.', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395'], 'Configs' => [ - 'description' => 'List of redirect configurations.', + 'description' => 'The redirect configuration list.', 'type' => 'array', 'items' => [ - 'description' => 'Details of the redirect configuration.', + 'description' => 'The redirect configuration details.', 'type' => 'object', 'properties' => [ - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '35281609698****'."\n", - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'Version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the effective version of the site configuration, with the default being version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'Rule execution order. The smaller the value, the higher the priority.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Rule switch. This parameter does not need to be set when adding a global configuration. Possible values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter does not need to be set when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'Rule name. This parameter does not need to be set when adding a global configuration.', - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'Configuration type. Possible values:'."\n" - .'- global: Global configuration.'."\n" - .'- rule: Rule configuration.', - 'type' => 'string', - 'example' => 'rule', - 'title' => '', - ], - 'Type' => [ - 'description' => 'Redirect type. Possible values:'."\n" - .'- static: Static mode.'."\n" - .'- dynamic: Dynamic mode.', - 'type' => 'string', - 'example' => 'static', - 'title' => '', - ], - 'TargetUrl' => [ - 'description' => 'Target URL after redirection.', - 'type' => 'string', - 'example' => 'http://www.exapmle.com/index.html'."\n", - 'title' => '', - ], - 'StatusCode' => [ - 'description' => 'Response status code used by the node to respond to the client with the redirect address. Possible values:'."\n" - .'- 301'."\n" - .'- 302'."\n" - .'- 303'."\n" - .'- 307'."\n" - .'- 308', - 'type' => 'string', - 'example' => '301', - 'title' => '', - ], - 'ReserveQueryString' => [ - 'description' => 'Preserve query string. Value range:'."\n" - .'- on: enabled.'."\n" - .'- off: disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '35281609698****'."\n", 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Sequence' => ['description' => 'The rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuleEnable' => ['description' => 'The rule switch. You do not need to set this parameter when adding a global configuration. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'The rule content, which uses a conditional expression to match user requests. You do not need to set this parameter when adding a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: set the value to true.'."\n" + .'- Match specified requests: set the value to a custom expression, for example, (http.host eq \\"video.example.com\\").', 'type' => 'string', 'example' => '(http.host eq "video.example.com")', 'title' => ''], + 'RuleName' => ['description' => 'The rule name. You do not need to set this parameter when adding a global configuration.', 'type' => 'string', 'example' => 'rule_example', 'title' => ''], + 'ConfigType' => ['description' => 'The configuration type. Valid values:'."\n" + .'- global: global configuration.'."\n" + .'- rule: rule configuration.', 'type' => 'string', 'example' => 'rule', 'title' => ''], + 'Type' => ['description' => 'The redirect type. Valid values:'."\n" + ."\n" + .'- static: static pattern.'."\n" + .'- dynamic: dynamic schema.', 'type' => 'string', 'example' => 'static', 'title' => ''], + 'TargetUrl' => ['description' => 'The target URL after the redirect.', 'type' => 'string', 'example' => 'http://www.exapmle.com/index.html'."\n", 'title' => ''], + 'StatusCode' => ['description' => 'The HTTP status code used when the node responds to the client with the redirect address. Valid values:'."\n" + .'- 301'."\n" + .'- 302'."\n" + .'- 303'."\n" + .'- 307'."\n" + .'- 308.', 'type' => 'string', 'example' => '301', 'title' => ''], + 'ReserveQueryString' => ['description' => 'Specifies whether to preserve the query string. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], ], 'title' => '', 'example' => '', @@ -66143,34 +37148,10 @@ 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'description' => 'Current page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'Page size.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'Total number of items.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'TotalPage' => [ - 'description' => 'Total number of pages.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], + 'PageNumber' => ['description' => 'The current page number, which is the same as the PageNumber request parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'example' => '', ], @@ -66178,32 +37159,17 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', - 'title' => 'Query Redirect Configuration List', + 'title' => 'Query redirect configuration list', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListRedirectRules', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRedirectRules'], ], ], 'ramActions' => [ @@ -66214,232 +37180,117 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'operationType' => 'read', ], 'ListRewriteUrlRules' => [ - 'summary' => 'List of Rewrite URL Rules', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the list of URL rewrite configurations for a site.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257644', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '35281609698****', 'title' => ''], ], [ 'name' => 'ConfigType', 'in' => 'query', 'schema' => [ - 'title' => '配置类型，可以根据此参数查全局配置或者功能配置，只有传了functionName才生效', - 'description' => 'Configuration type, which can be used to query global or rule configurations. Value range:'."\n" - .'- global: Query global configuration;'."\n" - .'- rule: Query rule configuration;'."\n" + 'title' => '', + 'description' => 'The configuration type. You can use this parameter to query global configurations or rule configurations. Valid values:'."\n" + .'- global: queries global configurations.'."\n" + .'- rule: queries rule configurations.'."\n" ."\n" - .'This parameter is optional. If not provided, it does not distinguish between global and rule configurations. This parameter only takes effect when the functionName parameter is provided.', + .'This parameter is optional. If you do not specify this parameter, both global and rule configurations are returned. This parameter takes effect only when the functionName parameter is specified.', + 'enumValueTitles' => ['rule' => 'rule configuration.', 'global' => 'global configuration.'], 'type' => 'string', + 'enum' => ['global', 'rule'], 'required' => false, 'example' => 'global', - 'enum' => [ - 'global', - 'rule', - ], ], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'title' => '规则名，可以查出规则名为所传字段的那条规则，只有传了functionName才生效', - 'description' => 'Rule name. Not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - ], + 'schema' => ['title' => '', 'description' => 'The rule name. You do not need to set this parameter when adding a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '第几页，不传时默认为1', - 'description' => 'Page number.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number for a paged query. The value must be greater than or equal to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '每页几条，最大500，不传时默认500', - 'description' => 'Page size. Range: **1~500**, default is **500**.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page for a paged query. Valid values: 1 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the effective version of the configuration, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. The default value is version 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Request response result.', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE'], 'Configs' => [ - 'description' => 'List of rewrite URL configurations.', + 'description' => 'The list of URL rewrite configurations.', 'type' => 'array', 'items' => [ - 'description' => 'Configuration details.', + 'description' => 'The configuration details.', 'type' => 'object', 'properties' => [ - 'ConfigId' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '39538644977****', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'Version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the effective version of the configuration, defaulting to version 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'Rule execution order. The smaller the value, the higher the priority.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Rule switch. Not required when adding a global configuration. Value range:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. Not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, e.g., (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'Rule name. Not required when adding a global configuration.', - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'Configuration type. Value range:'."\n" - .'- global: Global configuration;'."\n" - .'- rule: Rule configuration;', - 'type' => 'string', - 'example' => 'global', - 'title' => '', - ], - 'RewriteUriType' => [ - 'description' => 'URI rewrite type. Value range:'."\n" - .'- static: Static mode.'."\n" - .'- dynamic: Dynamic mode.', - 'type' => 'string', - 'example' => 'static', - 'title' => '', - ], - 'Uri' => [ - 'description' => 'Target URI after rewriting.', - 'type' => 'string', - 'example' => '/image.example.com/index.html'."\n", - 'title' => '', - ], - 'RewriteQueryStringType' => [ - 'description' => 'Query string rewrite type. Value range:'."\n" - .'- static: Static mode.'."\n" - .'- dynamic: Dynamic mode.', - 'type' => 'string', - 'example' => 'static', - 'title' => '', - ], - 'QueryString' => [ - 'description' => 'The rewritten query string.', - 'type' => 'string', - 'example' => 'example=123'."\n", - 'title' => '', - ], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '39538644977****', 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. The default value is version 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Sequence' => ['description' => 'The rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuleEnable' => ['description' => 'The rule switch. You do not need to set this parameter when adding a global configuration. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'The rule content, which uses a conditional expression to match user requests. You do not need to set this parameter when adding a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: set the value to true.'."\n" + .'- Match specified requests: set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', 'type' => 'string', 'example' => '(http.host eq "video.example.com")', 'title' => ''], + 'RuleName' => ['description' => 'The rule name. You do not need to set this parameter when adding a global configuration.', 'type' => 'string', 'example' => 'rule_example', 'title' => ''], + 'ConfigType' => ['description' => 'The configuration type. Valid values:'."\n" + .'- global: global configuration.'."\n" + .'- rule: rule configuration.', 'type' => 'string', 'example' => 'global', 'title' => ''], + 'RewriteUriType' => ['description' => 'The path rewrite type. Valid values:'."\n" + ."\n" + .'- static: static pattern.'."\n" + .'- dynamic: dynamic schema.', 'type' => 'string', 'example' => 'static', 'title' => ''], + 'Uri' => ['description' => 'The target URI after rewriting.', 'type' => 'string', 'example' => '/image.example.com/index.html'."\n", 'title' => ''], + 'RewriteQueryStringType' => ['description' => 'The query string rewrite type. Valid values:'."\n" + ."\n" + .'- static: static pattern.'."\n" + .'- dynamic: dynamic schema.', 'type' => 'string', 'example' => 'static', 'title' => ''], + 'QueryString' => ['description' => 'The query string after rewriting.', 'type' => 'string', 'example' => 'example=123'."\n", 'title' => ''], ], 'title' => '', 'example' => '', @@ -66447,34 +37298,10 @@ 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'description' => 'The current page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The size of the page.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of items.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - 'title' => '', - ], - 'TotalPage' => [ - 'description' => 'Total number of pages.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], + 'PageNumber' => ['description' => 'The current page number, which is the same as the PageNumber request parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'example' => '', ], @@ -66482,32 +37309,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', - 'title' => 'List of Rewrite URL Configurations for a Site', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'Query URL rewrite configurations for a site', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListRewriteUrlRules', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRewriteUrlRules'], ], ], 'ramActions' => [ @@ -66518,28 +37333,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'operationType' => 'read', ], 'ListRoutineCodeVersions' => [ - 'summary' => 'Queries the code versions of a function (routine) by page.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Queries the code version information of a specified Edge Routine program by paging.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -66548,155 +37351,72 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239374', - 'abilityTreeNodes' => [ - 'FEATUREdcdn75UYDO', - ], + 'abilityTreeNodes' => ['FEATUREdcdn75UYDO'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The function name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Edge Routine.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number of the returned page. Default value: 1. Valid values: 1 and 2.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number. Default value: 1. Maximum value: 2.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 20.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 20.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'SearchKeyWord', 'in' => 'formData', - 'schema' => [ - 'description' => 'The keyword used for fuzzy search.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hello', - 'title' => '', - ], + 'schema' => ['description' => 'The keyword for fuzzy matching.', 'type' => 'string', 'required' => false, 'example' => 'hello', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - ], - 'PageNumber' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of code versions returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], 'CodeVersions' => [ - 'description' => 'The code versions of the routine.'."\n", + 'description' => 'The list of Edge Routine code versions.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the code version.'."\n", + 'description' => 'The information about a code version.', 'type' => 'object', 'properties' => [ - 'CodeDescription' => [ - 'description' => 'The description of the code version.'."\n", - 'type' => 'string', - 'example' => 'test desc', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the code version was created.'."\n", - 'type' => 'string', - 'example' => '2024-04-16T09:42:47Z', - 'title' => '', - ], - 'CodeVersion' => [ - 'description' => 'The version of the code.'."\n", - 'type' => 'string', - 'example' => '1723599747213377175', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the code version.'."\n", - 'type' => 'string', - 'example' => 'Available', - 'title' => '', - ], - 'ExtraInfo' => [ - 'description' => 'Additional information about the code version.'."\n", - 'type' => 'string', - 'example' => '{\\"approver\\":[\\"348678\\",\\"111133\\",\\"411544\\"]}', - 'title' => '', - ], - 'BuildId' => [ - 'description' => 'The ID of the code version build.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '25801233', - 'title' => '', - ], + 'CodeDescription' => ['description' => 'The description of the code version.', 'type' => 'string', 'example' => 'test desc', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the code version was created, in RFC 3339 format in the UTC time zone.', 'type' => 'string', 'example' => '2024-04-16T09:42:47Z', 'title' => ''], + 'CodeVersion' => ['description' => 'The code version number.', 'type' => 'string', 'example' => '1723599747213377175', 'title' => ''], + 'Status' => ['description' => 'The status of the code version.', 'type' => 'string', 'example' => 'Available', 'title' => ''], + 'ExtraInfo' => ['description' => 'The additional information about the code version.', 'type' => 'string', 'example' => '{\\"approver\\":[\\"348678\\",\\"111133\\",\\"411544\\"]}', 'title' => ''], + 'BuildId' => ['description' => 'The build ID of the code version.', 'type' => 'integer', 'format' => 'int64', 'example' => '25801233', 'title' => ''], 'ConfOptions' => [ - 'description' => 'Code version configuration items.'."\n", + 'description' => 'The configuration items of the code version.', 'type' => 'object', 'properties' => [ - 'NotFoundStrategy' => [ - 'description' => 'Code version configuration items NotFoundStrategy.'."\n", - 'type' => 'string', - 'example' => 'SinglePageApplication', - 'title' => '', - ], + 'NotFoundStrategy' => ['description' => 'The NotFoundStrategy configuration item of the code version.', 'type' => 'string', 'example' => 'SinglePageApplication', 'title' => ''], ], 'title' => '', 'example' => '', ], + 'DeployEnv' => ['description' => 'The deployment environment. Valid values:'."\n" + .'- **staging**: staging environment.'."\n" + .'- **production**: production environment.', 'type' => 'string', 'example' => 'staging', 'title' => ''], + 'HasEnvVars' => ['description' => 'Indicates whether environment variables exist.', 'type' => 'boolean', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', @@ -66711,77 +37431,41 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'RoutineNotExist', - 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', - 'description' => 'The routine name does not exist. Check the routine name and try again.', - ], - [ - 'errorCode' => 'InternalOperationError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'RoutineNotExist', 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', 'description' => 'The routine name does not exist. Check the routine name and try again.'], + ['errorCode' => 'InternalOperationError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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"}]', - 'title' => 'ListRoutineCodeVersions', - 'description' => '本接口用于查询指定 Routine 程序的代码版本列表，支持分页查询及模糊搜索。用户可以通过设置 `Name` 参数来指定 Routine 程序名，'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + '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 \\"DeployEnv\\": \\"staging\\",\\n \\"HasEnvVars\\": false\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query edge routine code versions', + 'description' => 'Queries the code version list of a specified Edge Routine program. This operation supports paging and fuzzy search. You can set the Name parameter to specify the Edge Routine program name, use PageNumber and PageSize for paging control, and use SearchKeyWord for fuzzy matching against code version descriptions.'."\n" ."\n" - .'通过 `PageNumber` 和 `PageSize` 进行分页控制，以及使用 `SearchKeyWord` 进行关键词模糊匹配查询代码版本描述。'."\n" - ."\n" - .'返回结果将包含每个代码版本的修订号、描述、创建时间等详细信息。', + .'The response includes detailed information about each code version, such as the revision number, description, and creation time.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListRoutineCodeVersions', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRoutineCodeVersions'], ], ], 'ramActions' => [ [ - 'operationType' => 'none', + 'operationType' => 'list', 'ramAction' => [ 'action' => 'esa:ListRoutineCodeVersions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListRoutineRelatedRecords' => [ - 'summary' => 'The records associated with the function.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -66794,126 +37478,53 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '266954', - 'abilityTreeNodes' => [ - 'FEATUREdcdn75UYDO', - ], + 'abilityTreeNodes' => ['FEATUREdcdn75UYDO'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the function.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the function.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number of the returned page. Default value: 1'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number of the returned page. Default value: 1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values: an integer from 1 to 20.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values: an integer from 1 to 20.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'SearchKeyWord', 'in' => 'formData', - 'schema' => [ - 'description' => 'The keyword used for fuzzy search.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hello', - 'title' => '', - ], + 'schema' => ['description' => 'The keyword used for fuzzy search.', 'type' => 'string', 'required' => false, 'example' => 'hello', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - ], - 'PageNumber' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74'], + 'PageNumber' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '16', 'title' => ''], 'RelatedRecords' => [ - 'description' => 'The list of records associated with the edge function.'."\n", + 'description' => 'The list of records associated with the edge function.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the record associated with the function.'."\n", + 'description' => 'The information about the record associated with the function.', 'type' => 'object', 'properties' => [ - 'RecordName' => [ - 'description' => 'The name of the record.'."\n", - 'type' => 'string', - 'example' => 'test-record-1.example.com', - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '54362329990032', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com', - 'title' => '', - ], - 'RecordId' => [ - 'description' => 'The record ID of the domain name.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '509348423011904', - 'title' => '', - ], + 'RecordName' => ['description' => 'The name of the record.', 'type' => 'string', 'example' => 'test-record-1.example.com', 'title' => ''], + 'SiteId' => ['description' => 'The website ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '54362329990032', 'title' => ''], + 'SiteName' => ['description' => 'The website name.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'RecordId' => ['description' => 'The record ID of the domain name.', 'type' => 'integer', 'format' => 'int64', 'example' => '509348423011904', 'title' => ''], ], 'title' => '', 'example' => '', @@ -66928,45 +37539,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'DependedByOthers', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'RoutineNotExist', - 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', - 'description' => 'The routine name does not exist. Check the routine name and try again.', - ], - [ - 'errorCode' => 'InternalOperationError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'DependedByOthers', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'RoutineNotExist', 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', 'description' => 'The routine name does not exist. Check the routine name and try again.'], + ['errorCode' => 'InternalOperationError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - '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"}]', 'title' => 'ListRoutineRelatedRecords', - 'description' => '用于查询指定边缘函数的关联记录列表，您可以通过设置分页参数来获取部分结果，或者使用模糊关键词来筛选特定的记录条目。', + 'summary' => 'The records associated with the function.', + 'description' => 'Queries the list of related records for a specified edge routine. You can use pagination parameters to retrieve partial results, or use fuzzy keywords to filter specific record entries.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '20', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListRoutineRelatedRecords', - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRoutineRelatedRecords'], ], ], 'ramActions' => [ @@ -66977,26 +37563,17 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', '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' => [ - 'summary' => 'Queries the routes of an edge function.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the function route list of an Edge Routine.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -67009,164 +37586,65 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '266195', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number for a paged query. The value must be greater than or equal to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The number of entries per page. Maximum value: 500. Default value: 500.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page for a paged query. Valid values: 1 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'RoutineName', 'in' => 'query', - 'schema' => [ - 'description' => 'The function name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-routine1', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Edge Routine.', 'type' => 'string', 'required' => true, 'example' => 'test-routine1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n", - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n"], 'Configs' => [ - 'description' => 'The returned configurations.'."\n", + 'description' => 'The configuration information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '554889455535696', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'test.com', - 'title' => '', - ], - 'ConfigId' => [ - 'description' => 'The configuration ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '35281609698****'."\n", - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'The version number of the website configurations.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'The order in which the rule is executed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RouteEnable' => [ - 'description' => 'The route switch. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'The rule content.'."\n", - 'type' => 'string', - 'example' => '(http.host eq \\"video.example.com\\")'."\n", - 'title' => '', - ], - 'RouteName' => [ - 'description' => 'The route name.'."\n", - 'type' => 'string', - 'example' => 'test_route', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'The configuration type to query. Valid values:'."\n" - ."\n" - .'* global: global configurations.'."\n" - .'* rule: queries rule configurations.'."\n", - 'type' => 'string', - 'example' => 'global', - 'title' => '', - ], - 'RoutineName' => [ - 'description' => 'The routine name.'."\n", - 'type' => 'string', - 'example' => 'test-routine1'."\n", - 'title' => '', - ], - 'Bypass' => [ - 'description' => 'Bypass mode. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Mode' => [ - 'description' => 'The configuration mode. Valid values:'."\n" - ."\n" - .'* simple: Simple mode.'."\n" - .'* custom: Custom mode.'."\n", - 'type' => 'string', - 'example' => 'simple', - 'title' => '', - ], - 'Fallback' => [ - 'description' => 'The exception origin switch. After you turn on this switch, if a function exception occurs, such as CPU usage exceeding the upper limit, requests are sent back to the origin. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '554889455535696', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'test.com', 'title' => ''], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '35281609698****'."\n", 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the site configuration.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Sequence' => ['description' => 'The rule execution order.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RouteEnable' => ['description' => 'The route switch. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'The rule content.', 'type' => 'string', 'example' => '(http.host eq \\"video.example.com\\")'."\n", 'title' => ''], + 'RouteName' => ['description' => 'The route name.', 'type' => 'string', 'example' => 'test_route', 'title' => ''], + 'ConfigType' => ['description' => 'The configuration type. You can use this parameter to query global configurations or rule configurations. Valid values:'."\n" + ."\n" + .'- global: queries global configurations.'."\n" + .'- rule: queries rule configurations.', 'type' => 'string', 'example' => 'global', 'title' => ''], + 'RoutineName' => ['description' => 'The name of the Edge Routine.', 'type' => 'string', 'example' => 'test-routine1'."\n", 'title' => ''], + 'Bypass' => ['description' => 'The bypass mode. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Mode' => ['description' => 'The configuration mode. Valid values:'."\n" + .'- simple: simple mode.'."\n" + .'- custom: custom mode.', 'type' => 'string', 'example' => 'simple', 'title' => ''], + 'Fallback' => ['description' => 'The fallback-to-origin switch. After this switch is enabled, requests are sent to the origin server if the function encounters an exception such as CPU usage exceeding the limit. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Timeout' => ['title' => '', 'description' => 'The ER timeout period. Valid values: 5 to 60. Unit: seconds.', 'type' => 'string', 'example' => '5'], ], 'description' => '', 'title' => '', @@ -67175,34 +37653,10 @@ 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '83', - 'title' => '', - ], - 'TotalPage' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - 'title' => '', - ], + 'PageNumber' => ['description' => 'The current page number, which is the same as the PageNumber request parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '83', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], 'example' => '', ], @@ -67210,38 +37664,22 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], ], ], - '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"}]', - 'title' => 'ListRoutineRoutes', + '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 \\"Timeout\\": \\"5\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 83,\\n \\"TotalPage\\": 2\\n}","type":"json"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'Query the function route list of an edge routine', 'changeSet' => [ - [ - 'createdAt' => '2025-06-25T05:35:34.000Z', - 'description' => 'Response parameters changed', - ], - [ - 'createdAt' => '2025-04-08T06:41:11.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-06-25T05:35:34.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-04-08T06:41:11.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '20', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListRoutineRoutes', - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRoutineRoutes'], ], ], 'ramActions' => [ @@ -67252,25 +37690,16 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListScheduledPreloadExecutions' => [ - 'summary' => 'Lists the plans in a scheduled prefetch task by task ID.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Lists the execution plans of a specified scheduled prefetch task by task ID.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -67283,100 +37712,44 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239200', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4TTNAL', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4TTNAL'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the scheduled prefetch task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '665d3af3621bccf3fe29e1a4', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the scheduled prefetch task.', 'type' => 'string', 'required' => true, 'example' => '665d3af3621bccf3fe29e1a4', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ET5BF670-09D5-4D0B-BEBY-D96A2A528000', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ET5BF670-09D5-4D0B-BEBY-D96A2A528000'], 'Executions' => [ - 'description' => 'The information about prefetch plans returned.'."\n", + 'description' => 'The execution information.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the prefetch plan returned.'."\n", + 'description' => 'The execution information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the prefetch plan.'."\n", - 'type' => 'string', - 'example' => '66599bd7397885b43804901c', - 'title' => '', - ], - 'StartTime' => [ - 'description' => 'The start time of the prefetch plan.'."\n", - 'type' => 'string', - 'example' => '2024-05-31T17:10:48.849+08:00', - 'title' => '', - ], - 'EndTime' => [ - 'description' => 'The end time of the prefetch plan.'."\n", - 'type' => 'string', - 'example' => '2024-05-31T18:10:48.849+08:00', - 'title' => '', - ], - 'Interval' => [ - 'description' => 'The time interval between each batch execution in the plan. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - 'title' => '', - ], - 'SliceLen' => [ - 'description' => 'The number of URLs prefetched in each batch.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the prefetch plan. Valid values:'."\n" - ."\n" - .'* **waiting**'."\n" - .'* **running**'."\n" - .'* **finished**'."\n" - .'* **failed**'."\n" - .'* **stopped**', - 'type' => 'string', - 'example' => 'running', - 'title' => '', - ], - 'JobId' => [ - 'description' => 'The ID of the prefetch task.'."\n", - 'type' => 'string', - 'example' => '665d3af3621bccf3fe29e1a4', - 'title' => '', - ], - 'AliUid' => [ - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => '15685865xxx14622', - 'title' => '', - ], + 'Id' => ['description' => 'The ID of the prefetch plan.', 'type' => 'string', 'example' => '66599bd7397885b43804901c', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the scheduled prefetch plan, in ISO 8601 format (such as 2024-01-01T00:00:00+Z).', 'type' => 'string', 'example' => '2024-05-31T17:10:48.849+08:00', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the scheduled prefetch plan, in ISO 8601 format (such as 2024-01-01T00:00:00+Z).', 'type' => 'string', 'example' => '2024-05-31T18:10:48.849+08:00', 'title' => ''], + 'Interval' => ['description' => 'The interval between each batch execution of the scheduled prefetch plan. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'SliceLen' => ['description' => 'The number of URLs in each batch of the scheduled prefetch.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Status' => ['description' => 'The status of the scheduled prefetch plan. Valid values:'."\n" + .'- **waiting**: Waiting to be executed.'."\n" + .'- **running**: Being executed.'."\n" + .'- **finished**: Execution completed.'."\n" + .'- **failed**: Execution failed.'."\n" + .'- **stopped**: Execution paused.', 'type' => 'string', 'example' => 'running', 'title' => ''], + 'JobId' => ['description' => 'The ID of the prefetch task.', 'type' => 'string', 'example' => '665d3af3621bccf3fe29e1a4', 'title' => ''], + 'AliUid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '15685865xxx14622', 'title' => ''], ], 'title' => '', 'example' => '', @@ -67384,13 +37757,7 @@ 'title' => '', 'example' => '', ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - 'title' => '', - ], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], 'example' => '', ], @@ -67398,104 +37765,37 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], - [ - 'errorCode' => 'InvalidJob.JobCountOfSiteFull', - 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', - 'description' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', - ], - [ - 'errorCode' => 'InvalidParameter.ObjectId', - 'errorMessage' => 'Invalid task ID or execution plan ID.', - 'description' => 'Invalid task ID or execution plan ID.', - ], - [ - 'errorCode' => 'MissingOssUrl', - 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', - 'description' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', - ], - [ - 'errorCode' => 'MissingUrlList', - 'errorMessage' => 'Enter the URLs you want to prefetch.', - 'description' => 'Enter the URLs you want to prefetch.', - ], - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests.Please try again later.', - 'description' => 'Requests are too frequent, please try again later.', - ], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'InvalidJob.JobCountOfSiteFull', 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', 'description' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.'], + ['errorCode' => 'InvalidParameter.ObjectId', 'errorMessage' => 'Invalid task ID or execution plan ID.', 'description' => 'Invalid task ID or execution plan ID.'], + ['errorCode' => 'MissingOssUrl', 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', 'description' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.'], + ['errorCode' => 'MissingUrlList', 'errorMessage' => 'Enter the URLs you want to prefetch.', 'description' => 'Enter the URLs you want to prefetch.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], ], 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' => '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.', - ], + ['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' => '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.'], ], [ - [ - 'errorCode' => 'InvalidJob.NotFound', - 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', - 'description' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', - ], - [ - 'errorCode' => 'LogNotFound', - 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', - 'description' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', - ], - [ - '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' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.', - ], + ['errorCode' => 'InvalidJob.NotFound', 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', 'description' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.'], + ['errorCode' => 'LogNotFound', 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', 'description' => 'Failed to query the log. Check whether the task ID and execution ID are valid.'], + ['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' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', - 'title' => 'ListScheduledPreloadExecutions', + 'title' => 'List execution plans of a specified scheduled prefetch task', '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListScheduledPreloadExecutions'], ], ], + 'ramActions' => [], ], 'ListScheduledPreloadJobs' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Lists scheduled prefetch tasks for a site.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -67508,207 +37808,81 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238775', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4TTNAL', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4TTNAL'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '', - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '190007158391808', - ], + 'schema' => ['title' => '', 'description' => 'Site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '190007158391808'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the task creation time range to query. Specify the timestamp in milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1717225276000', - 'title' => '', - ], + 'schema' => ['description' => 'The beginning of the time range to query based on task creation time, in millisecond timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1717225276000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The end time for querying the task creation time range. Specify the timestamp in milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1717225277000', - 'title' => '', - ], + 'schema' => ['description' => 'The end of the time range to query based on task creation time, in millisecond timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1717225277000', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number to retrieve.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '20', - 'default' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The page size, indicating the number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '20', 'example' => '20'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', - ], - 'TotalCount' => [ - 'description' => 'The total number of tasks returned.'."\n", - 'type' => 'string', - 'example' => '5', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'], + 'TotalCount' => ['description' => 'The total number of records after filtering.', 'type' => 'string', 'example' => '5', 'title' => ''], 'Jobs' => [ - 'description' => 'The list of the prefetch tasks.'."\n", + 'description' => 'The list of prefetch task information.', 'type' => 'array', 'items' => [ - 'description' => 'The details of prefetch tasks.'."\n", + 'description' => 'The prefetch task information.', 'type' => 'object', 'properties' => [ - 'AliUid' => [ - 'title' => '', - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => '15685865xxx14622', - ], - 'CreatedAt' => [ - 'title' => '', - 'description' => 'The time when the task was created.'."\n", - 'type' => 'string', - 'example' => '2024-06-01T08:53:13Z', - ], - 'Domains' => [ - 'title' => '', - 'description' => 'The domain names to be prefetched.'."\n", - 'type' => 'string', - 'example' => 'testurl.com', - ], - 'ErrorInfo' => [ - 'title' => '', - 'description' => 'The error message that is returned.'."\n", - 'type' => 'string', - 'example' => 'invalid domain:test.com', - ], - 'FailedFileOss' => [ - 'title' => '', - 'description' => 'The URL of the OSS object that stores a list of URLs that failed the conditional check for prefetching.'."\n", - 'type' => 'string', - 'example' => 'https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7', - ], - 'FileId' => [ - 'title' => '', - 'description' => 'The ID of the URL list file, which can be used during downloads.'."\n", - 'type' => 'string', - 'example' => '665d3b48621bccf3fe29e1a7', - ], - 'Id' => [ - 'title' => '', - 'description' => 'The ID of the prefetch task.'."\n", - 'type' => 'string', - 'example' => '665d3af3621bccf3fe29e1a4'."\n", - ], + 'AliUid' => ['title' => '', 'description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '15685865xxx14622'], + 'CreatedAt' => ['title' => '', 'description' => 'The task creation time in ISO 8601 format (e.g., 2024-01-01T00:00:00+Z).', 'type' => 'string', 'example' => '2024-06-01T08:53:13Z'], + 'Domains' => ['title' => '', 'description' => 'The list of prefetch domains.', 'type' => 'string', 'example' => 'testurl.com'], + 'ErrorInfo' => ['title' => '', 'description' => 'The error information.', 'type' => 'string', 'example' => 'invalid domain:test.com'], + 'FailedFileOss' => ['title' => '', 'description' => 'The OSS URL of the failed file.', 'type' => 'string', 'example' => 'https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7'], + 'FileId' => ['title' => '', 'description' => 'The URL list file ID (used for downloading).', 'type' => 'string', 'example' => '665d3b48621bccf3fe29e1a7'], + 'Id' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => '665d3af3621bccf3fe29e1a4'."\n"], 'InsertWay' => [ 'title' => '', - 'description' => 'The method to submit the URLs to be prefetched.'."\n", + 'description' => 'The URL insertion method.', + 'enumValueTitles' => ['oss' => 'Batch import URLs via OSS file', 'testBox' => 'Enter URLs one by one via text box'], 'type' => 'string', + 'enum' => ['file', 'url'], 'example' => 'oss', - 'enum' => [ - 'file', - 'url', - ], - ], - 'Name' => [ - 'title' => '', - 'description' => 'The task name.'."\n", - 'type' => 'string', - 'example' => 'example', - ], - 'SiteId' => [ - 'title' => '', - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '190007158391808', - ], - 'TaskSubmitted' => [ - 'title' => '', - 'description' => 'The number of submitted prefetch tasks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', ], + 'Name' => ['title' => '', 'description' => 'The task name.', 'type' => 'string', 'example' => 'example'], + 'SiteId' => ['title' => '', 'description' => 'Site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '190007158391808'], + 'TaskSubmitted' => ['title' => '', 'description' => 'The number of URLs that have been submitted to the system for prefetch.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'TaskType' => [ 'title' => '', - 'description' => 'The task type. Valid values: refresh and preload.'."\n", + 'description' => 'The task type (refresh/prefetch).', + 'enumValueTitles' => ['path' => 'Directory refresh', 'refresh' => 'URL refresh', 'preload' => 'URL prefetch'], 'type' => 'string', + 'enum' => ['preload', 'refresh', 'path'], 'example' => 'preload', - 'enum' => [ - 'preload', - 'refresh', - 'path', - ], - ], - 'UrlCount' => [ - 'title' => '', - 'description' => 'The total number of URLs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'UrlSubmitted' => [ - 'title' => '', - 'description' => 'The number of submitted URLs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ExecutionCount' => [ - 'description' => 'Number of prefetch schedules.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', ], + 'UrlCount' => ['title' => '', 'description' => 'The total number of URLs.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'UrlSubmitted' => ['title' => '', 'description' => 'The number of submitted URLs.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ExecutionCount' => ['description' => 'The number of prefetch plans.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', @@ -67723,108 +37897,38 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], - [ - 'errorCode' => 'InvalidJob.JobCountOfSiteFull', - 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', - 'description' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', - ], - [ - 'errorCode' => 'InvalidParameter.ObjectId', - 'errorMessage' => 'Invalid task ID or execution plan ID.', - 'description' => 'Invalid task ID or execution plan ID.', - ], - [ - 'errorCode' => 'MissingOssUrl', - 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', - 'description' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', - ], - [ - 'errorCode' => 'MissingUrlList', - 'errorMessage' => 'Enter the URLs you want to prefetch.', - 'description' => 'Enter the URLs you want to prefetch.', - ], - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests.Please try again later.', - 'description' => 'Requests are too frequent, please try again later.', - ], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'InvalidJob.JobCountOfSiteFull', 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', 'description' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.'], + ['errorCode' => 'InvalidParameter.ObjectId', 'errorMessage' => 'Invalid task ID or execution plan ID.', 'description' => 'Invalid task ID or execution plan ID.'], + ['errorCode' => 'MissingOssUrl', 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', 'description' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.'], + ['errorCode' => 'MissingUrlList', 'errorMessage' => 'Enter the URLs you want to prefetch.', 'description' => 'Enter the URLs you want to prefetch.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], ], 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' => '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.', - ], + ['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' => '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.'], ], [ - [ - 'errorCode' => 'InvalidJob.NotFound', - 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', - 'description' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', - ], - [ - 'errorCode' => 'LogNotFound', - 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', - 'description' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', - ], - [ - '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' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.', - ], + ['errorCode' => 'InvalidJob.NotFound', 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', 'description' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.'], + ['errorCode' => 'LogNotFound', 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', 'description' => 'Failed to query the log. Check whether the task ID and execution ID are valid.'], + ['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' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.'], ], ], - 'title' => 'List scheduled prefetch jobs', - 'summary' => 'List the scheduled prefetch jobs under a site.', + '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"}]', + 'title' => 'List Scheduled Prefetch Tasks', 'changeSet' => [ - [ - 'createdAt' => '2025-03-13T08:02:14.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-03-13T08:02:14.000Z', 'description' => 'Response parameters changed'], ], '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}', - ], - ], - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListScheduledPreloadJobs'], ], ], - '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"}]', + 'ramActions' => [], ], 'ListSiteDeliveryTasks' => [ 'summary' => 'Lists all log delivery tasks that are in progress.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -67836,63 +37940,34 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238497', - 'abilityTreeNodes' => [ - 'FEATUREdcdn9K10I1', - ], + 'abilityTreeNodes' => ['FEATUREdcdn9K10I1'], ], 'parameters' => [ [ 'name' => 'BusinessType', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '', - 'description' => 'The log category. Valid values:'."\n" - ."\n" - .'* dcdn_log_access_l1 (default): access logs.'."\n" - .'* dcdn_log_er: Edge Routine logs.'."\n" - .'* dcdn_log_waf: firewall logs.'."\n" - .'* dcdn_log_ipa: TCP/UDP proxy logs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dcdn_log_access_l1', - ], + 'schema' => ['title' => '', 'description' => 'The log category. Valid values:'."\n" + ."\n" + .'* dcdn_log_access_l1 (default): access logs.'."\n" + .'* dcdn_log_er: Edge Routine logs.'."\n" + .'* dcdn_log_waf: firewall logs.'."\n" + .'* dcdn_log_ipa: TCP/UDP proxy logs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dcdn_log_access_l1'], ], [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456***', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456***', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 20.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -67902,87 +37977,39 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', - ], - 'TotalCount' => [ - 'description' => 'The total number of log delivery tasks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], - 'PageNumber' => [ - 'description' => 'The page number. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Valid values: **1 to 500**. Default value: **20**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD'], + 'TotalCount' => ['description' => 'The total number of log delivery tasks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'PageNumber' => ['description' => 'The page number. Default value: 0.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Valid values: **1 to 500**. Default value: **20**.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'Tasks' => [ 'description' => 'The delivery tasks.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'TaskName' => [ - 'description' => 'The name of the delivery task.'."\n", - 'type' => 'string', - 'example' => 'cdn-test-task', - 'title' => '', - ], - 'DeliveryType' => [ - 'description' => 'The destination of the delivery. Valid values:'."\n" - ."\n" - .'1. sls: Alibaba Cloud Simple Log Service (SLS).'."\n" - .'2. http: HTTP server.'."\n" - .'3. aws3: Amazon Simple Storage Service (S3).'."\n" - .'4. oss: Alibaba Cloud Object Storage Service (OSS).'."\n" - .'5. kafka: Kafka.'."\n" - .'6. aws3cmpt: S3-compatible storage service.'."\n", - 'type' => 'string', - 'example' => 'sls', - 'title' => '', - ], - 'DataCenter' => [ - 'description' => 'The data center. Valid values:'."\n" - ."\n" - .'* cn: the Chinese mainland.'."\n" - .'* sg: outside the Chinese mainland.'."\n", - 'type' => 'string', - 'example' => 'cn', - 'title' => '', - ], - 'BusinessType' => [ - 'description' => 'The log category. Valid values:'."\n" - ."\n" - .'* dcdn_log_access_l1 (default): access logs.'."\n" - .'* dcdn_log_er: Edge Routine logs.'."\n" - .'* dcdn_log_waf: firewall logs.'."\n" - .'* dcdn_log_ipa: TCP/UDP proxy logs.'."\n", - 'type' => 'string', - 'example' => 'dcdn_log_access_l1', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the delivery task.'."\n" - ."\n" - .'* **online**'."\n" - .'* **offline**'."\n", - 'type' => 'string', - 'example' => 'online', - 'title' => '', - ], + 'TaskName' => ['description' => 'The name of the delivery task.'."\n", 'type' => 'string', 'example' => 'cdn-test-task', 'title' => ''], + 'DeliveryType' => ['description' => 'The destination of the delivery. Valid values:'."\n" + ."\n" + .'1. sls: Alibaba Cloud Simple Log Service (SLS).'."\n" + .'2. http: HTTP server.'."\n" + .'3. aws3: Amazon Simple Storage Service (S3).'."\n" + .'4. oss: Alibaba Cloud Object Storage Service (OSS).'."\n" + .'5. kafka: Kafka.'."\n" + .'6. aws3cmpt: S3-compatible storage service.'."\n", 'type' => 'string', 'example' => 'sls', 'title' => ''], + 'DataCenter' => ['description' => 'The data center. Valid values:'."\n" + ."\n" + .'* cn: the Chinese mainland.'."\n" + .'* sg: outside the Chinese mainland.'."\n", 'type' => 'string', 'example' => 'cn', 'title' => ''], + 'BusinessType' => ['description' => 'The log category. Valid values:'."\n" + ."\n" + .'* dcdn_log_access_l1 (default): access logs.'."\n" + .'* dcdn_log_er: Edge Routine logs.'."\n" + .'* dcdn_log_waf: firewall logs.'."\n" + .'* dcdn_log_ipa: TCP/UDP proxy logs.'."\n", 'type' => 'string', 'example' => 'dcdn_log_access_l1', 'title' => ''], + 'Status' => ['description' => 'The status of the delivery task.'."\n" + ."\n" + .'* **online**'."\n" + .'* **offline**'."\n", 'type' => 'string', 'example' => 'online', 'title' => ''], ], 'description' => '', 'title' => '', @@ -67998,37 +38025,19 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'ListSiteDeliveryTasks', 'changeSet' => [ - [ - 'createdAt' => '2024-09-27T05:57:02.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-27T05:57:02.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListSiteDeliveryTasks', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSiteDeliveryTasks'], ], ], 'ramActions' => [ @@ -68039,12 +38048,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -68056,12 +38060,9 @@ ], ], 'ListSiteOriginClientCertificates' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the list of back-to-origin client certificates at the site level.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -68074,95 +38075,38 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '261747', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The site ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. The default value is **1**.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number. Default value: **1**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - 'title' => '', - ], + 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of real-time log projects.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '90', - 'title' => '', - ], - 'PageNumber' => [ - 'description' => 'The page number. The default value is 1.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1024', - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'The site ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456789****', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The site name.', - 'type' => 'string', - 'example' => 'example.com ', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of real-time log projects.', 'type' => 'integer', 'format' => 'int64', 'example' => '90', 'title' => ''], + 'PageNumber' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '1024', 'title' => ''], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789****', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com ', 'title' => ''], 'Result' => [ 'description' => 'The list of certificate information.', 'type' => 'array', @@ -68170,96 +38114,21 @@ 'description' => 'The certificate information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The certificate ID.', - 'type' => 'string', - 'example' => 'babaabcd****', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The certificate name.', - 'type' => 'string', - 'example' => 'yourCertName', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The certificate status.', - 'type' => 'string', - 'example' => 'OK', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The certificate type.', - 'type' => 'string', - 'example' => 'upload', - 'title' => '', - ], - 'CommonName' => [ - 'description' => 'The common name of the certificate.', - 'type' => 'string', - 'example' => 'www.example.com ', - 'title' => '', - ], - 'NotBefore' => [ - 'description' => 'The start time of the certificate validity period.', - 'type' => 'string', - 'example' => '2023-03-31 02:08:00', - 'title' => '', - ], - 'NotAfter' => [ - 'description' => 'The end time of the certificate validity period.', - 'type' => 'string', - 'example' => '2024-03-31 02:08:00', - 'title' => '', - ], - 'Issuer' => [ - 'description' => 'The certification authority.', - 'type' => 'string', - 'example' => 'DigiCert', - 'title' => '', - ], - 'SAN' => [ - 'description' => 'The subject alternative name (SAN) of the certificate.', - 'type' => 'string', - 'example' => 'www.example.com,*.example.com', - 'title' => '', - ], - 'SignatureAlgorithm' => [ - 'description' => 'The signature algorithm of the certificate.', - 'type' => 'string', - 'example' => 'SHA256-RSA', - 'title' => '', - ], - 'PubkeyAlgorithm' => [ - 'description' => 'The public-key algorithm of the certificate.', - 'type' => 'string', - 'example' => 'RSA', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the certificate was created.', - 'type' => 'string', - 'example' => '2024-06-24 07:48:51', - 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'The time when the certificate was last updated.', - 'type' => 'string', - 'example' => '2022-09-22 05:33:13', - 'title' => '', - ], - 'SerialNumber' => [ - 'description' => 'The certificate serial number.', - 'type' => 'string', - 'example' => 'babaded901474b9693acf530e0fb1d**', - 'title' => '', - ], - 'FingerprintSha256' => [ - 'description' => 'The SHA-256 fingerprint of the certificate.', - 'type' => 'string', - 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', - 'title' => '', - ], + 'Id' => ['description' => 'The certificate ID.', 'type' => 'string', 'example' => 'babaabcd****', 'title' => ''], + 'Name' => ['description' => 'The certificate name.', 'type' => 'string', 'example' => 'yourCertName', 'title' => ''], + 'Status' => ['description' => 'The certificate status.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Type' => ['description' => 'The certificate type.', 'type' => 'string', 'example' => 'upload', 'title' => ''], + 'CommonName' => ['description' => 'The common name of the certificate.', 'type' => 'string', 'example' => 'www.example.com ', 'title' => ''], + 'NotBefore' => ['description' => 'The start time of the certificate validity period. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2023-03-31 02:08:00', 'title' => ''], + 'NotAfter' => ['description' => 'The end time of the certificate validity period. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-03-31 02:08:00', 'title' => ''], + 'Issuer' => ['description' => 'The certification authority.', 'type' => 'string', 'example' => 'DigiCert', 'title' => ''], + 'SAN' => ['description' => 'The Subject Alternative Name (SAN) of the certificate.', 'type' => 'string', 'example' => 'www.example.com,*.example.com', 'title' => ''], + 'SignatureAlgorithm' => ['description' => 'The signature algorithm of the certificate.', 'type' => 'string', 'example' => 'SHA256-RSA', 'title' => ''], + 'PubkeyAlgorithm' => ['description' => 'The public key algorithm of the certificate.', 'type' => 'string', 'example' => 'RSA', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2024-06-24 07:48:51', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.', 'type' => 'string', 'example' => '2022-09-22 05:33:13', 'title' => ''], + 'SerialNumber' => ['description' => 'The sequence number of the certificate.', 'type' => 'string', 'example' => 'babaded901474b9693acf530e0fb1d**', 'title' => ''], + 'FingerprintSha256' => ['description' => 'The SHA-256 fingerprint of the certificate.', 'type' => 'string', 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****', 'title' => ''], ], 'title' => '', 'example' => '', @@ -68274,53 +38143,41 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], ], - 'title' => 'ListSiteOriginClientCertificates', - 'summary' => 'Lists the back-to-origin client certificates for a site.', + '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"}]', + 'title' => 'List site-level origin client certificates', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSiteOriginClientCertificates'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'esa:ListSiteOriginClientCertificates', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], + ], + ], ], - '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' => [ - 'summary' => 'Queries the edge function routes for a website.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the list of Edge Routine routes for a site.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -68333,191 +38190,85 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '266194', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '35281609698****', 'title' => ''], ], [ 'name' => 'ConfigType', 'in' => 'query', 'schema' => [ 'title' => '', - 'description' => 'The configuration type. You can use this parameter to query global configurations or feature configurations. This parameter takes effect only if the functionName parameter is passed.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* global'."\n" - .'* rule'."\n", + 'description' => 'The configuration type. You can use this parameter to query global or feature configurations. This parameter takes effect only when functionName is specified.', + 'enumValueTitles' => ['rule' => 'rule configuration.', 'global' => 'global configuration.'], 'type' => 'string', + 'enum' => ['global', 'rule'], 'required' => false, - 'enum' => [ - 'global', - 'rule', - ], 'example' => 'global', ], ], [ 'name' => 'RouteName', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The rule name. This parameter takes effect only when parameter functionName is specified.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_route', - ], + 'schema' => ['title' => '', 'description' => 'The route name. You can use this parameter to query the rule whose name matches the specified value. This parameter takes effect only when functionName is specified.', 'type' => 'string', 'required' => false, 'example' => 'test_route'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number for a paged query. The value must be greater than or equal to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The number of entries per page. Maximum value: 500. Default value: 500.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page for a paged query. Valid values: 1 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n", - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n"], 'Configs' => [ - 'description' => 'The returned configurations.'."\n", + 'description' => 'The configuration list in the response.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ConfigId' => [ - 'description' => 'The configuration ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '35281609698****'."\n", - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'The version number of the website.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'The order in which the rule is executed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RouteEnable' => [ - 'description' => 'The route switch. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'The rule content.'."\n", - 'type' => 'string', - 'example' => '(http.host eq \\"video.example.com\\")', - 'title' => '', - ], - 'RouteName' => [ - 'description' => 'The route name.'."\n", - 'type' => 'string', - 'example' => 'test_route', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'The configuration type to query. Valid values:'."\n" - ."\n" - .'* global: global configurations.'."\n" - .'* rule: queries rule configurations.'."\n", - 'type' => 'string', - 'example' => 'global', - 'title' => '', - ], - 'RoutineName' => [ - 'description' => 'The function name.'."\n", - 'type' => 'string', - 'example' => 'test-routine1', - 'title' => '', - ], - 'Bypass' => [ - 'description' => 'The bypass mode. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Mode' => [ - 'description' => 'The configuration mode. Specifies whether to check the image used by the instance supports hot migration. Valid values:'."\n" - ."\n" - .'* simple: Simple Mode'."\n" - .'* custom: Custom Mode'."\n", - 'type' => 'string', - 'example' => 'simple', - 'title' => '', - ], - 'Fallback' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '35281609698****'."\n", 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the site.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Sequence' => ['description' => 'The execution order of the rule.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RouteEnable' => ['description' => 'The route switch. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'The rule content.', 'type' => 'string', 'example' => '(http.host eq \\"video.example.com\\")', 'title' => ''], + 'RouteName' => ['description' => 'The route name.', 'type' => 'string', 'example' => 'test_route', 'title' => ''], + 'ConfigType' => ['description' => 'The configuration type. You can use this parameter to query global or rule configurations. Valid values:'."\n" + ."\n" + .'- global: Queries global configurations.'."\n" + .'- rule: Queries rule configurations.', 'type' => 'string', 'example' => 'global', 'title' => ''], + 'RoutineName' => ['description' => 'The Edge Routine name.', 'type' => 'string', 'example' => 'test-routine1', 'title' => ''], + 'Bypass' => ['description' => 'The bypass mode. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Mode' => ['description' => 'The configuration mode. Valid values:'."\n" + .'- simple: Simple mode.'."\n" + .'- custom: Custom mode.', 'type' => 'string', 'example' => 'simple', 'title' => ''], + 'Fallback' => ['description' => 'The CDN fallback. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Timeout' => ['description' => 'The Edge Routine timeout period, in seconds.', 'type' => 'string', 'example' => '60', 'title' => ''], ], 'description' => '', 'title' => '', @@ -68526,34 +38277,10 @@ 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - 'title' => '', - ], - 'TotalPage' => [ - 'description' => 'The total number of pages returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], + 'PageNumber' => ['description' => 'The current page number, which is the same as the PageNumber request parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'example' => '', ], @@ -68561,34 +38288,21 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], ], ], - '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"}]', - 'title' => 'ListSiteRoutes', + '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\\": \\"on\\",\\n \\"Timeout\\": \\"60\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 16,\\n \\"TotalPage\\": 10\\n}","type":"json"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'Query edge routine routes for a site', 'changeSet' => [ - [ - 'createdAt' => '2025-06-25T05:35:34.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-06-25T05:35:34.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '20', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListSiteRoutes', - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSiteRoutes'], ], ], 'ramActions' => [ @@ -68599,25 +38313,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], ], 'ListSites' => [ - 'summary' => 'Query Site List', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the list of sites under the current user, including site names, statuses, and configurations.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -68630,93 +38335,55 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239591', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'SiteName', 'in' => 'query', - 'schema' => [ - 'description' => 'The website name. This parameter specifies a filter condition for the query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'example.com', - 'title' => '', - ], + 'schema' => ['description' => 'The site name. Used as a filter condition for the query.', 'type' => 'string', 'required' => false, 'example' => 'example.com', 'title' => ''], ], [ 'name' => 'SiteSearchType', 'in' => 'query', 'schema' => [ - 'description' => 'The match mode to search for the website name. Default value: exact. Valid values:'."\n" + 'description' => 'The search matching mode for the site name. Default is exact match. Valid values:'."\n" ."\n" - .'* **prefix**: match by prefix.'."\n" - .'* **suffix**: match by suffix.'."\n" - .'* **exact**: exact match.'."\n" - .'* **fuzzy**: fuzzy match.'."\n", + .'- **prefix**: prefix match.'."\n" + .'- **suffix**: suffix match.'."\n" + .'- **exact**: exact match.'."\n" + .'- **fuzzy**: fuzzy match.', + 'enumValueTitles' => [], 'type' => 'string', + 'enum' => ['suffix', 'exact', 'prefix', 'fuzzy'], 'required' => false, 'example' => 'fuzzy', - 'enum' => [ - 'suffix', - 'exact', - 'prefix', - 'fuzzy', - ], 'title' => '', ], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number for paging. The value must be greater than or equal to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: **500**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries per page for paging. Valid values: 1 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'TagFilter', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The tag filtering rule.'."\n", + 'description' => 'The tag filter rules.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key. This parameter specifies a filter condition for the query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tag1', - 'title' => '', - ], - 'Value' => [ - 'description' => 'The tag value. This parameter specifies a filter condition for the query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aaa', - 'title' => '', - ], + 'Key' => ['description' => 'The tag key. Used as a filter condition for the query.', 'type' => 'string', 'required' => false, 'example' => 'tag1', 'title' => ''], + 'Value' => ['description' => 'The tag value. Used as a filter condition for the query.', 'type' => 'string', 'required' => false, 'example' => 'aaa', 'title' => ''], ], 'required' => false, 'description' => '', @@ -68731,94 +38398,54 @@ [ 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group. This parameter specifies a filter condition for the query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aekzd3styujvyei', - 'title' => '', - ], + 'schema' => ['description' => 'The resource group ID. Used as a filter condition for the query.', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzd3styujvyei', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => 'The website status. This parameter specifies a filter condition for the query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pending', - 'title' => '', - ], + 'schema' => ['description' => 'The site status. Used as a filter condition for the query.', 'type' => 'string', 'required' => false, 'example' => 'pending', 'title' => ''], ], [ 'name' => 'OnlyEnterprise', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to query only websites on Enterprise plans. Valid values: **true and false**.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to query only Enterprise Edition sites. Set this parameter to **true** to query only Enterprise Edition sites.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'PlanSubscribeType', 'in' => 'query', - 'schema' => [ - 'description' => 'The plan type. Valid values:'."\n" - ."\n" - .'* **basicplan**: Entrance'."\n" - .'* **standardplan**: Pro'."\n" - .'* **advancedplan**: Premium'."\n" - .'* **enterpriseplan**: Enterprise', - 'type' => 'string', - 'required' => false, - 'example' => 'basicplan', - 'title' => '', - ], + 'schema' => ['description' => 'The plan subscription type. Valid values:'."\n" + .'- **basicplan**: Basic Edition.'."\n" + .'- **standardplan**: Standard Edition.'."\n" + .'- **advancedplan**: Premium Edition.'."\n" + .'- **enterpriseplan**: Enterprise Edition.', 'type' => 'string', 'required' => false, 'example' => 'basicplan', 'title' => ''], ], [ 'name' => 'Coverage', 'in' => 'query', - 'schema' => [ - 'description' => 'The service location. Valid values:'."\n" - ."\n" - .'* **domestic**: the Chinese mainland'."\n" - .'* **global**: global'."\n" - .'* **overseas**: outside the Chinese mainland'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'global', - 'title' => '', - ], + 'schema' => ['description' => 'The acceleration region. Valid values:'."\n" + .'- **domestic**: the Chinese mainland only.'."\n" + .'- **global**: global.'."\n" + .'- **overseas**: global (excluding the Chinese mainland).', 'type' => 'string', 'required' => false, 'example' => 'global', 'title' => ''], ], [ 'name' => 'AccessType', 'in' => 'query', - 'schema' => [ - 'description' => 'The DNS setup. Valid values:'."\n" - ."\n" - .'* **NS**'."\n" - .'* **CNAME**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NS', - 'title' => '', - ], + 'schema' => ['description' => 'The access type. Valid values:'."\n" + ."\n" + .'- **NS**: NS-based access.'."\n" + ."\n" + .'- **CNAME**: CNAME-based access.', 'type' => 'string', 'required' => false, 'example' => 'NS', 'title' => ''], ], [ 'name' => 'OrderBy', 'in' => 'query', 'schema' => [ - 'description' => 'Sorting field. By default, it sorts by creation time, supporting the following options:'."\n" - .'- gmtCreate: website creation time'."\n" - .'- visitTime: website visit time', + 'description' => 'The sort field. By default, results are sorted by creation time. Valid values:'."\n" + .'- gmtCreate: site creation time.'."\n" + .'- visitTime: site access time.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'visitTime' => 'visitTime', - 'gmtCreate' => 'gmtCreate', - ], 'example' => 'visitTime', 'title' => '', ], @@ -68829,160 +38456,50 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of websites per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of websites.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '40', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'], + 'PageNumber' => ['description' => 'The page number of the returned data.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of sites displayed per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of sites.', 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''], 'Sites' => [ - 'description' => 'The queried websites.'."\n", + 'description' => 'The list of queried site information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'AccessType' => [ - 'description' => 'The DNS setup for the website. Valid values:'."\n" - ."\n" - .'* **NS**'."\n" - .'* **CNAME**'."\n", - 'type' => 'string', - 'example' => 'NS', - 'title' => '', - ], - 'CnameZone' => [ - 'description' => 'The CNAME of the website domain. If you use CNAME setup when you add your website to ESA, the value is the CNAME that you configured then.'."\n", - 'type' => 'string', - 'example' => 'example.cname.com', - 'title' => '', - ], - 'Coverage' => [ - 'description' => 'The service location for the website. Valid values:'."\n" - ."\n" - .'* **domestic**: the Chinese mainland'."\n" - .'* **global**: global'."\n" - .'* **overseas**: outside the Chinese mainland'."\n", - 'type' => 'string', - 'example' => 'domestic', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the website was added. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-12-24T02:01:11Z', - 'title' => '', - ], - 'UpdateTime' => [ - 'description' => 'The time when the website was updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-12-24T02:01:11Z', - 'title' => '', - ], - 'InstanceId' => [ - 'description' => 'The ID of the plan associated with the website.'."\n", - 'type' => 'string', - 'example' => 'onBvtlmIyeXLbiDw81F9', - 'title' => '', - ], - 'NameServerList' => [ - 'description' => 'The nameservers assigned to the website domain, which are separated by commas (,).'."\n", - 'type' => 'string', - 'example' => 'male1-1.ialicdn.com,female1-1.ialicdn.com', - 'title' => '', - ], - 'PlanName' => [ - 'description' => 'The plan name.'."\n", - 'type' => 'string', - 'example' => 'plan-168656498****', - 'title' => '', - ], - 'PlanSpecName' => [ - 'description' => 'The plan associated with the website.'."\n", - 'type' => 'string', - 'example' => 'normal', - 'title' => '', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-aek26g6i6se6pna', - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456789****', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The website status. Valid values:'."\n" - ."\n" - .'* **pending**: The website is to be configured.'."\n" - .'* **active**: The website is active.'."\n" - .'* **offline**: The website is suspended.'."\n" - .'* **moved**: The website has been added and verified by another Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => 'pending', - 'title' => '', - ], - 'Tags' => [ - 'description' => 'The tags of the website.'."\n", - 'type' => 'object', - 'example' => '{"tag1":"value1"}', - 'title' => '', - ], - 'VerifyCode' => [ - 'description' => 'The code that is used to verify the website domain ownership. As part of the verification TXT record, this parameter is returned for websites that use CNAME setup.'."\n", - 'type' => 'string', - 'example' => 'verify_d516cb3740f81f0cef77d162edd1****', - 'title' => '', - ], - 'VisitTime' => [ - 'description' => 'The website visit time is represented in the ISO 8601 date format using UTC time, formatted as yyyy-MM-ddTHH:mm:ssZ.', - 'type' => 'string', - 'example' => '2023-12-24T02:01:11Z', - 'title' => '', - ], - 'OfflineReason' => [ - 'type' => 'string', - 'description' => 'Reason for site deactivation. Valid values:'."\n" - ."\n" - .'- **expiration_arrears**: The subscription package has expired or the account has an overdue payment.'."\n" - .'- **internally_disabled**: The site was disabled internally by the system.'."\n" - .'- **missing_icp**: The domain name lacks an ICP filing.'."\n" - .'- **content_violation**: Content violation.'."\n" - .'- **proactively_disabled**: You manually deactivated the site or the usage cap you set triggered deactivation.', - 'example' => 'expiration_ arrears', - 'title' => '', - ], + 'AccessType' => ['description' => 'The site access type. Valid values:'."\n" + ."\n" + .'- **NS**: NS-based access.'."\n" + .'- **CNAME**: CNAME-based access.', 'type' => 'string', 'example' => 'NS', 'title' => ''], + 'CnameZone' => ['description' => 'The CNAME suffix of the site. For sites that use CNAME-based access, this is the CNAME suffix that needs to be configured for records.', 'type' => 'string', 'example' => 'example.cname.com', 'title' => ''], + 'Coverage' => ['description' => 'The acceleration region of the site. Valid values:'."\n" + ."\n" + .'- **domestic**: the Chinese mainland only.'."\n" + .'- **global**: global.'."\n" + .'- **overseas**: global (excluding the Chinese mainland).', 'type' => 'string', 'example' => 'domestic', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time of the site. The time is in ISO 8601 format and displayed in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2023-12-24T02:01:11Z', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time of the site. The time is in ISO 8601 format and displayed in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2023-12-24T02:01:11Z', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID of the plan attached to the site.', 'type' => 'string', 'example' => 'onBvtlmIyeXLbiDw81F9', 'title' => ''], + 'NameServerList' => ['description' => 'The list of name servers assigned to the site. Multiple values are separated by commas (,).', 'type' => 'string', 'example' => 'male1-1.ialicdn.com,female1-1.ialicdn.com', 'title' => ''], + 'PlanName' => ['description' => 'The plan name.', 'type' => 'string', 'example' => 'plan-168656498****', 'title' => ''], + 'PlanSpecName' => ['description' => 'The specification name of the site plan.', 'type' => 'string', 'example' => 'normal', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-aek26g6i6se6pna', 'title' => ''], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789****', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'Status' => ['description' => 'The site status. Valid values:'."\n" + .'- **pending**: the site is pending configuration.'."\n" + .'- **active**: the site is activated.'."\n" + .'- **offline**: the site is offline.'."\n" + .'- **moved**: the site has been superseded.', 'type' => 'string', 'example' => 'pending', 'title' => ''], + 'Tags' => ['description' => 'The site tags.', 'type' => 'object', 'example' => '{"tag1":"value1"}', 'title' => ''], + 'VerifyCode' => ['description' => 'The site ownership verification code. When a site uses CNAME-based access, this TXT verification code must be configured.', 'type' => 'string', 'example' => 'verify_d516cb3740f81f0cef77d162edd1****', 'title' => ''], + 'VisitTime' => ['description' => 'The access time of the site. The time is in ISO 8601 format and displayed in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2023-12-24T02:01:11Z', 'title' => ''], + 'OfflineReason' => ['description' => 'The reason why the site is disabled. Valid values:'."\n" + ."\n" + .'- **expiration_ arrears**: The subscription plan has expired or the account has an overdue payment.'."\n" + .'- **internally_disabled**: The site is disabled by the system.'."\n" + .'- **missing_icp**: The domain name does not have an ICP filing.'."\n" + .'- **content_violation**: Content violation.'."\n" + .'- **proactively_disabled**: You proactively disabled the site or the site is disabled because the usage cap you configured is reached.', 'type' => 'string', 'example' => 'expiration_ arrears', 'title' => ''], ], 'description' => '', 'title' => '', @@ -69000,36 +38517,19 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'title' => 'Query Site List', + '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"}]', + 'title' => 'Query site list', 'changeSet' => [ - [ - 'createdAt' => '2025-02-18T05:59:13.000Z', - 'description' => 'Response parameters changed', - ], - [ - 'createdAt' => '2024-11-28T06:41:39.000Z', - 'description' => 'Request parameters changed, Response parameters changed', - ], - [ - 'createdAt' => '2024-09-23T07:16:48.000Z', - 'description' => 'Error codes changed, Request parameters changed', - ], + ['createdAt' => '2025-02-18T05:59:13.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-28T06:41:39.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-09-23T07:16:48.000Z', 'description' => 'Error codes changed, Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListSites', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSites'], ], ], 'ramActions' => [ @@ -69040,28 +38540,16 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', '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' => 'Queries tags based on the region ID and resource type.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Queries tags by region ID and resource type.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -69074,9 +38562,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239641', - 'abilityTreeNodes' => [ - 'FEATUREdcdn6S5O3S', - ], + 'abilityTreeNodes' => ['FEATUREdcdn6S5O3S'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ @@ -69084,28 +38570,18 @@ 'name' => 'RegionId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The ID of the region where the resources reside.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - 'title' => '', - ], + 'schema' => ['description' => 'The region ID. Valid values:'."\n" + .'- Alibaba Cloud China Website (www.aliyun.com): cn-hangzhou'."\n" + .'- Alibaba Cloud International Website (www.alibabacloud.com): ap-southeast-1.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The website ID.'."\n", + 'description' => 'The resource ID. Enter a site ID or a DNS record ID. You must specify at least one of ResourceId and Tag.', 'type' => 'array', - 'items' => [ - 'description' => 'The website ID. The number of supported website IDs. Valid values: **1** to **50**.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123456xxxxx', - 'title' => '', - ], + 'items' => ['description' => 'The resource ID. Enter a site ID or a DNS record ID.', 'type' => 'string', 'required' => false, 'example' => '123456xxxxx', 'title' => ''], 'required' => false, 'maxItems' => 51, 'title' => '', @@ -69117,26 +38593,14 @@ 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'A list of tags. You can enter up to 20 tags.'."\n", + 'description' => 'The list of tags. You can specify up to 20 tags. You must specify at least one of ResourceId and Tag.', 'type' => 'array', 'items' => [ - 'description' => 'A list of tags. You can enter up to 20 tags.'."\n", + 'description' => 'The list of tags. You can specify up to 20 tags.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '', - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'env', - ], - 'Value' => [ - 'title' => '', - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value', - ], + 'Key' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'env'], + 'Value' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value'], ], 'required' => false, 'title' => '', @@ -69152,39 +38616,22 @@ 'name' => 'ResourceType', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The resource type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'site', - 'title' => '', - ], + 'schema' => ['description' => 'The resource type. Valid values:'."\n" + ."\n" + .'- site: site'."\n" + .'- record: DNS record.', 'type' => 'string', 'required' => true, 'example' => 'site', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n" - ."\n" - .'> This parameter is not required for the first request. If not all results are returned in one query, you can specify the token that is obtained from the previous query as the value of **NextToken**.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AAAAAZjtYxxxxxxxx', - 'title' => '', - ], + 'schema' => ['description' => 'The token for the next query to return more results.'."\n" + .'> You do not need to specify this parameter for the first query. If a query does not return all results, pass the **NextToken** value returned from the previous query to continue the query.', 'type' => 'string', 'required' => false, 'example' => 'AAAAAZjtYxxxxxxxx', 'title' => ''], ], [ 'name' => 'MaxItem', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of tags to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - 'title' => '', - ], + 'schema' => ['description' => 'The maximum number of entries to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ @@ -69192,49 +38639,22 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', - 'title' => '', - ], - 'NextToken' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'AAAAAYwsxxxxxxx', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', 'title' => ''], + 'NextToken' => ['description' => 'The token for the next query. If NextToken is empty, all information has been displayed on the current page.', 'type' => 'string', 'example' => 'AAAAAYwsxxxxxxx', 'title' => ''], 'TagResources' => [ - 'description' => 'The tags of the resource.'."\n", + 'description' => 'The resource tags.', 'type' => 'array', 'items' => [ - 'description' => 'The tags of the resource.'."\n", + 'description' => 'The resource tags.', 'type' => 'object', 'properties' => [ - 'TagKey' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'env', - 'title' => '', - ], - 'TagValue' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'value', - 'title' => '', - ], - 'ResourceId' => [ - 'description' => 'The resource ID.'."\n", - 'type' => 'string', - 'example' => 'example.com', - 'title' => '', - ], - 'ResourceType' => [ - 'description' => 'The resource type.'."\n", - 'type' => 'string', - 'example' => 'site', - 'title' => '', - ], + 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'env', 'title' => ''], + 'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'value', 'title' => ''], + 'ResourceId' => ['description' => 'The resource ID. Enter a site ID or a DNS record ID.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'ResourceType' => ['description' => 'The resource type. Valid values:'."\n" + ."\n" + .'- site: site'."\n" + .'- record: DNS record.', 'type' => 'string', 'example' => 'site', 'title' => ''], ], 'title' => '', 'example' => '', @@ -69242,13 +38662,7 @@ 'title' => '', 'example' => '', ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'description' => '', 'title' => '', @@ -69258,44 +38672,22 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.TagValue', - 'errorMessage' => 'The specified TagValue is invalid.', - 'description' => 'The TagValue parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidNextToken', - 'errorMessage' => 'The specified parameter NextToken is invalid.', - 'description' => 'The parameter NextToken is illegal.', - ], + ['errorCode' => 'InvalidParameter.TagValue', 'errorMessage' => 'The specified TagValue is invalid.', 'description' => 'The TagValue parameter is invalid.'], + ['errorCode' => 'InvalidNextToken', 'errorMessage' => 'The specified parameter NextToken is invalid.', 'description' => 'The parameter NextToken is illegal.'], ], 404 => [ - [ - 'errorCode' => 'InvalidResourceId.NotFound', - 'errorMessage' => 'The specified resource does not exist or is released.', - 'description' => 'The resource does not exist or has been released.', - ], + ['errorCode' => 'InvalidResourceId.NotFound', 'errorMessage' => 'The specified resource does not exist or is released.', 'description' => 'The resource does not exist or has been released.'], ], ], - 'title' => 'ListTagResources', + '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"}]', + 'title' => 'Query tags', 'changeSet' => [ - [ - 'createdAt' => '2025-08-21T07:40:23.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T06:13:41.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-08-21T07:40:23.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T06:13:41.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListTagResources', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'], ], ], 'ramActions' => [ @@ -69306,26 +38698,156 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => 'List of Transport Layer Applications', - 'methods' => [ - 'get', + 'ListTraceTasks' => [ + 'summary' => 'Retrieves a list of diagnostic tasks.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '241915', + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], + ], + 'parameters' => [ + [ + 'name' => 'DiagnoseId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The diagnose ID.', 'type' => 'string', 'example' => 'f2xxx5', 'required' => false], + ], + [ + 'name' => 'TraceId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The diagnostic trace ID.', 'type' => 'string', 'example' => '000000xxxxxxxxxxxxxxxxxxxxxx33427e', 'required' => false], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The diagnostic task ID.', 'type' => 'string', 'example' => 'xxxxxxxxxx-x-x-xxxxxxxxxxxxxxxxx', 'required' => false], + ], + [ + 'name' => 'ClientIp', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The client IP address.', 'type' => 'string', 'example' => '60.xx.xxx.38', 'required' => false], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The domain name to diagnose.', 'type' => 'string', 'example' => 'http://www.example.com', 'required' => false], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The start time. Time zone: UTC/GMT.', 'type' => 'string', 'example' => '2006-01-02T15:04:05Z', 'required' => false], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The end time. Time zone: UTC/GMT.', 'type' => 'string', 'example' => '2006-01-02T15:04:05Z', 'required' => false], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'required' => false], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The page size. Valid values: any integer from 1 to 1000.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Count' => ['title' => '', 'description' => 'The number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'List' => [ + 'title' => '', + 'description' => 'The returned list information.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The object.', + 'type' => 'object', + 'properties' => [ + 'Aliuid' => ['title' => '', 'description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '1077********7468'], + 'ClientAddr' => ['title' => '', 'description' => 'The IP address of the local DNS server.', 'type' => 'string', 'example' => 'xx.xx.xx.xx'], + 'ClientIp' => ['title' => '', 'description' => 'The client IP address.', 'type' => 'string', 'example' => 'xx.xx.xx.xx'], + 'CreateTime' => ['title' => '', 'description' => 'The time when the report was created. Format: yyyy-MM-dd HH:mm:ss. Time zone: UTC+8.', 'type' => 'string', 'example' => '2022-12-10 15:11:47'], + 'DiagnoseId' => ['title' => '', 'description' => 'The diagnose ID.', 'type' => 'string', 'example' => 'f2a18ad5'], + 'DiagnoseUrl' => ['title' => '', 'description' => 'The diagnostic URL.', 'type' => 'string', 'example' => 'http://cdn.dns-detect.alicdn.com/diagnose/xxxxxx'], + 'Domain' => ['title' => '', 'description' => 'The domain name to diagnose.', 'type' => 'string', 'example' => 'http://www.example.com'], + 'ExpireTime' => ['title' => '', 'description' => 'The expiration time. The value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1669285111'], + 'RemainDiagnoseTimes' => ['title' => '', 'description' => 'The remaining number of available diagnostic attempts.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'State' => ['title' => '', 'description' => 'The report generation status. Valid values:'."\n" + ."\n" + .'- 0: Succeeded.'."\n" + .'- 1: Failed.'."\n" + .'- 2: Timed out.'."\n" + .'- 3: Running.'."\n" + .'- 4: Waiting.', 'type' => 'string', 'example' => '0'], + 'Status' => ['title' => '', 'description' => 'The status of the diagnostic URL. Valid values:'."\n" + ."\n" + .'- 1: active'."\n" + .'- 0: expired.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => '000000xxxxxxxxxxxxxxxxxxxxxxxxxxxx475e'], + 'TimeConsuming' => ['title' => '', 'description' => 'The time consumed to generate the report.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TraceId' => ['title' => '', 'description' => 'The diagnostic trace ID.', 'type' => 'string', 'example' => '000000xxxxxxxxxxxxxxxxxxxxxx25941e'], + ], + 'example' => '', + ], + 'example' => '', + ], + 'PageNumber' => ['title' => '', 'description' => 'The page number, starting from 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The page size. Valid values: any integer from 1 to 1000.', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4E09C5D7-E1CF-4CAA-A45E-8727F4C8FD70'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve diagnostic task list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:ListTraceTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Count\\": 10,\\n \\"List\\": [\\n {\\n \\"Aliuid\\": \\"1077********7468\\",\\n \\"ClientAddr\\": \\"xx.xx.xx.xx\\",\\n \\"ClientIp\\": \\"xx.xx.xx.xx\\",\\n \\"CreateTime\\": \\"2022-12-10 15:11:47\\",\\n \\"DiagnoseId\\": \\"f2a18ad5\\",\\n \\"DiagnoseUrl\\": \\"http://cdn.dns-detect.alicdn.com/diagnose/xxxxxx\\",\\n \\"Domain\\": \\"http://www.example.com\\",\\n \\"ExpireTime\\": 1669285111,\\n \\"RemainDiagnoseTimes\\": 10,\\n \\"State\\": \\"0\\",\\n \\"Status\\": 1,\\n \\"TaskId\\": \\"000000xxxxxxxxxxxxxxxxxxxxxxxxxxxx475e\\",\\n \\"TimeConsuming\\": 1,\\n \\"TraceId\\": \\"000000xxxxxxxxxxxxxxxxxxxxxx25941e\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 6,\\n \\"RequestId\\": \\"4E09C5D7-E1CF-4CAA-A45E-8727F4C8FD70\\"\\n}","type":"json"}]', + ], + 'ListTransportLayerApplications' => [ + 'summary' => 'Query the list of Layer 4 applications for a site.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -69338,65 +38860,38 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '245119', - 'abilityTreeNodes' => [ - 'FEATUREdcdn2E10XY', - ], + 'abilityTreeNodes' => ['FEATUREdcdn2E10XY'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456******', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID. You can obtain it by calling the [ListSites](~~2850189~~) API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456******', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'Page number set for pagination. Starting value: 1. Default value: 1.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number for paginated queries. The value must be greater than or equal to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Page size. The maximum value is 500.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '500', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries per page for paginated queries. Valid values: 1-500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '500', 'title' => ''], ], [ 'name' => 'MatchType', 'in' => 'query', 'schema' => [ - 'description' => 'Query type for the transport layer application host record, supporting the following 4 types, with exact query as the default.'."\n" + 'description' => 'The query type for the host record of Layer 4 applications. The following four types are supported, and the default is exact match.'."\n" ."\n" - .'- fuzzy: Fuzzy query.'."\n" - .'- exact: Exact query.'."\n" - .'- prefix: Prefix match query.'."\n" - .'- suffix: Suffix match query.', + .'- fuzzy: Fuzzy match.'."\n" + .'- exact: Exact match.'."\n" + .'- prefix: Prefix match.'."\n" + .'- suffix: Suffix match.', + 'enumValueTitles' => [], 'type' => 'string', + 'enum' => ['fuzzy', 'prefix', 'suffix', 'exact'], 'required' => false, - 'enum' => [ - 'fuzzy', - 'prefix', - 'suffix', - 'exact', - ], 'example' => 'fuzzy', 'title' => '', ], @@ -69404,129 +38899,59 @@ [ 'name' => 'RecordName', 'in' => 'query', - 'schema' => [ - 'description' => 'Host record of the transport layer application.', - 'type' => 'string', - 'required' => false, - 'example' => 'www.example.com', - 'title' => '', - ], + 'schema' => ['description' => 'The host record of the Layer 4 application.', 'type' => 'string', 'required' => false, 'example' => 'www.example.com', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Request response.', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', - ], - 'PageNumber' => [ - 'description' => 'Current page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'Page size.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'Total number of transport layer applications.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'], + 'PageNumber' => ['description' => 'The current page number, same as the PageNumber request parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of Layer 4 applications.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Applications' => [ - 'description' => 'List of transport layer applications.', + 'description' => 'The list of Layer 4 applications.', 'type' => 'array', 'items' => [ - 'description' => 'Details of the transport layer application.', + 'description' => 'Details of a Layer 4 application.', 'type' => 'object', 'properties' => [ 'Rules' => [ - 'description' => 'List of forwarding rules.', + 'description' => 'The list of forwarding rules.', 'type' => 'array', 'items' => [ - 'description' => 'Details of the forwarding rule.', + 'description' => 'Details of a forwarding rule.', 'type' => 'object', 'properties' => [ - 'Protocol' => [ - 'description' => 'Forwarding rule protocol, with values:'."\n" - ."\n" - .'- TCP: TCP protocol.'."\n" - .'- UDP: UDP protocol.', - 'type' => 'string', - 'example' => 'TCP', - 'title' => '', - ], - 'EdgePort' => [ - 'description' => 'Edge port. Supports:'."\n" - ."\n" - .'- A single port, e.g., 80.'."\n" - .'- Port range, e.g., 81-85, representing ports 81, 82, 83, 84, 85.'."\n" - .'- Combination of ports and port ranges, separated by commas, e.g., 80,81-85,90, representing ports 80, 81, 82, 83, 84, 85, 90.', - 'type' => 'string', - 'example' => '80', - 'title' => '', - ], - 'SourcePort' => [ - 'description' => 'Source port. Supports:'."\n" - ."\n" - .'- A single port, when the source port is a single port, any valid combination of edge ports is supported.'."\n" - .'- Port range, only when the edge port is a port range, the source port can be set to a port range, and the range size must be consistent with the edge port. For example, if the edge port is 90-93, the source port cannot be set to 81-85 because the source port range is 5 and the edge port range is 3, which are inconsistent.', - 'type' => 'string', - 'example' => '80', - 'title' => '', - ], - 'Source' => [ - 'description' => 'Specific value of the source, which needs to match the source type.', - 'type' => 'string', - 'example' => '1.1.1.1', - 'title' => '', - ], - 'Comment' => [ - 'description' => 'Comment information for the rule.', - 'type' => 'string', - 'example' => '测试', - 'title' => '', - ], - 'ClientIPPassThroughMode' => [ - 'description' => 'Client IP pass-through protocol, supports:'."\n" - .'- **off**: No pass-through.'."\n" - .'- **PPv1**: PROXY Protocol v1, supports client IP pass-through for TCP protocol.'."\n" - .'- **PPv2**: PROXY Protocol v2, supports client IP pass-through for TCP and UDP protocols.'."\n" - .'- **SPP**: Simple Proxy Protocol, supports client IP pass-through for UDP protocol.', - 'type' => 'string', - 'example' => 'off', - 'title' => '', - ], - 'SourceType' => [ - 'description' => 'Source type, supports:'."\n" - .'- **ip**: IP.'."\n" - .'- **domain**: Domain name.'."\n" - .'- **OP**: Origin pool.'."\n" - .'- **LB**: Load balancer.', - 'type' => 'string', - 'example' => 'ip', - 'title' => '', - ], - 'RuleId' => [ - 'description' => 'Layer 4 acceleration rule ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20258028****', - 'title' => '', - ], + 'Protocol' => ['description' => 'The protocol of the forwarding rule. Valid values:'."\n" + ."\n" + .'- TCP: TCP protocol.'."\n" + .'- UDP: UDP protocol.', 'type' => 'string', 'example' => 'TCP', 'title' => ''], + 'EdgePort' => ['description' => 'The edge port. Supported formats:'."\n" + ."\n" + .'- A single port, such as 80.'."\n" + .'- A port range, such as 81-85, which represents ports 81, 82, 83, 84, and 85.'."\n" + .'- A combination of ports and port ranges separated by commas, such as 80,81-85,90, which represents ports 80, 81, 82, 83, 84, 85, and 90.', 'type' => 'string', 'example' => '80', 'title' => ''], + 'SourcePort' => ['description' => 'The origin port. Supported formats:'."\n" + ."\n" + .'- A single port. When the origin port is a single port, any valid combination of edge ports is supported.'."\n" + .'- A port range. The origin port can be set to a port range only when the edge port is a port range, and the range size must be the same as that of the edge port. For example, if the edge port is 90-93, the origin port cannot be set to 81-85, because the origin port range size is 5 while the edge port range size is 3, which are inconsistent.', 'type' => 'string', 'example' => '80', 'title' => ''], + 'Source' => ['description' => 'The specific value of the origin, which must match the origin type.', 'type' => 'string', 'example' => '1.1.1.1', 'title' => ''], + 'Comment' => ['description' => 'The comment for the rule.', 'type' => 'string', 'example' => 'Test', 'title' => ''], + 'ClientIPPassThroughMode' => ['description' => 'The client IP pass-through protocol. Supported values:'."\n" + .'- **off**: Disabled.'."\n" + .'- **PPv1**: PROXY Protocol v1, which supports client IP pass-through for TCP protocol.'."\n" + .'- **PPv2**: PROXY Protocol v2, which supports client IP pass-through for TCP and UDP protocols.'."\n" + .'- **SPP**: Simple Proxy Protocol, which supports client IP pass-through for UDP protocol.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'SourceType' => ['description' => 'The origin type. Supported values:'."\n" + .'- **ip**: IP address.'."\n" + .'- **domain**: Domain name.'."\n" + .'- **OP**: Origin pool.'."\n" + .'- **LB**: Load balancer.', 'type' => 'string', 'example' => 'ip', 'title' => ''], + 'RuleId' => ['description' => 'The Layer 4 acceleration rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '20258028****', 'title' => ''], ], 'title' => '', 'example' => '', @@ -69534,137 +38959,99 @@ 'title' => '', 'example' => '', ], - 'ApplicationId' => [ - 'description' => 'Layer 4 application ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '170997271816****', - 'title' => '', - ], - 'RecordName' => [ - 'description' => 'Domain name of the Layer 4 application.', - 'type' => 'string', - 'example' => 'test.example.com'."\n", - 'title' => '', - ], - 'SiteId' => [ - 'description' => 'Site ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '36556540048****', - 'title' => '', - ], - 'RulesCount' => [ - 'description' => 'Number of forwarding rules contained in the Layer 4 acceleration application.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Cname' => [ - 'description' => 'CNAME domain name corresponding to the Layer 4 acceleration application. This field is not empty only when the site is accessed via CNAME.', - 'type' => 'string', - 'example' => 'example.com.ialicdn.com'."\n", - 'title' => '', - ], + 'ApplicationId' => ['description' => 'The Layer 4 application ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '170997271816****', 'title' => ''], + 'RecordName' => ['description' => 'The domain name of the Layer 4 application.', 'type' => 'string', 'example' => 'test.example.com'."\n", 'title' => ''], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '36556540048****', 'title' => ''], + 'RulesCount' => ['description' => 'The number of forwarding rules contained in the Layer 4 acceleration application.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Cname' => ['description' => 'The CNAME domain name corresponding to the Layer 4 acceleration application. This field is non-empty only when the site is connected via the CNAME method.', 'type' => 'string', 'example' => 'example.com.ialicdn.com'."\n", 'title' => ''], 'IpAccessRule' => [ - 'description' => 'IP access rule switch. When enabled, the IP access rules in WAF take effect on the Layer 4 application.'."\n" + 'description' => 'The IP access rule switch. When enabled, the IP access rules in WAF take effect for the Layer 4 application.'."\n" ."\n" .'- on: Enabled.'."\n" .'- off: Disabled.', + 'enumValueTitles' => [], 'type' => 'string', - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], 'example' => 'on', 'title' => '', ], 'Ipv6' => [ - 'description' => 'IPv6 switch.', + 'description' => 'The IPv6 switch. Valid values:'."\n" + ."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => [], 'type' => 'string', - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], 'example' => 'on', 'title' => '', ], 'Status' => [ - 'description' => 'Status of the Layer 4 application'."\n" + 'description' => 'The status of the Layer 4 application.'."\n" ."\n" - .'- **deploying**: Deploying. In this state, modification and deletion are not allowed.'."\n" + .'- **deploying**: Deploying. Modification and deletion are not allowed in this state.'."\n" .'- **active**: Active.', + 'enumValueTitles' => [], 'type' => 'string', - 'enumValueTitles' => [ - 'deploying' => 'deploying', - 'active' => 'active', - ], 'example' => 'active', 'title' => '', ], 'CrossBorderOptimization' => [ - 'description' => 'Whether to enable China mainland network access optimization. It is disabled by default. The value range is:'."\n" + 'description' => 'Indicates whether mainland China network access optimization is enabled. Disabled by default. Valid values:'."\n" ."\n" .'- on: Enabled.'."\n" .'- off: Disabled.', + 'enumValueTitles' => [], 'type' => 'string', - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], 'example' => 'on', 'title' => '', ], 'StaticIp' => [ - 'type' => 'string', - 'description' => 'Whether to enable a static IP. Disabled by default. Valid values: '."\n" + 'description' => 'Indicates whether static IP is enabled. Disabled by default. Valid values:'."\n" ."\n" - .'- on: Enabled. '."\n" - .'- off: No. ', - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => [], + 'type' => 'string', 'example' => 'on', 'title' => '', ], 'StaticIpV4List' => [ + 'description' => 'The list of static IPv4 addresses assigned to this Layer 4 application after the static IP feature is enabled.', 'type' => 'array', 'items' => [ + 'description' => 'A single static IPv4 address, including the IP address and its status.', 'type' => 'object', 'properties' => [ - 'Address' => [ - 'type' => 'string', - 'description' => 'IP address.', - 'example' => '1.1.1.2', - 'title' => '', - ], + 'Address' => ['description' => 'The IP address.', 'type' => 'string', 'example' => '1.1.1.2', 'title' => ''], 'Status' => [ - 'type' => 'string', 'description' => 'The status of the IP address. Valid values:'."\n" ."\n" .'- healthy: Healthy.'."\n" .'- unhealthy: Unhealthy.'."\n" - .'- unknown: IP is being prepared.', - 'enumValueTitles' => [ - 'healthy' => 'healthy', - 'unhealthy' => 'unhealthy', - 'unknown' => 'unknown', - ], + .'- unknown: IP address is being prepared.', + 'enumValueTitles' => [], + 'type' => 'string', 'example' => 'healthy', 'title' => '', ], ], - 'description' => 'A single static IPv4 address, including the IP address and its status.', 'title' => '', 'example' => '', ], 'required' => true, - 'description' => 'The list of assigned static IPv4 addresses for this Layer 4 application after the static IP feature is Enabled.', 'title' => '', 'example' => '', ], + 'KeepAliveProtection' => [ + 'title' => '', + 'description' => 'Indicates whether keep-alive protection is enabled. Disabled by default. Valid values:'."\n" + ."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => ['on', 'off'], + 'example' => 'off', + ], ], 'title' => '', 'example' => '', @@ -69680,21 +39067,17 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - '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' => 'List of Transport Layer Acceleration Applications for a Site', + '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\\": \\"Test\\",\\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 \\"KeepAliveProtection\\": \\"off\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query the list of Layer 4 acceleration applications for a site', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTransportLayerApplications'], + ], ], 'ramActions' => [ [ @@ -69704,25 +39087,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], ], 'ListUploadTasks' => [ - 'summary' => 'Queries the execution status and running information of file upload tasks based on the task time and type.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Lists the execution status and runtime information of file upload tasks by time and type.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -69735,140 +39109,72 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239070', - 'abilityTreeNodes' => [ - 'FEATUREdcdnBCJPGN', - 'FEATUREdcdnRELTJV', - 'FEATUREdcdnEWYS3A', - 'FEATUREdcdn4TTNAL', - ], + 'abilityTreeNodes' => ['FEATUREdcdnBCJPGN', 'FEATUREdcdnRELTJV', 'FEATUREdcdnEWYS3A', 'FEATUREdcdn4TTNAL'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can obtain this value by calling the [ListSites](~~2850189~~) operation.'."\n" + .'>This parameter is required when you call the ListUploadTasks operation.>.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the task starts. Specify the time in the YYYY-MM-DDThh:mm:ssZ format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2018-11-29T00:00:00Z', - 'title' => '', - ], + 'schema' => ['description' => 'The start time in ISO 8601 format (for example, 2024-01-01T00:00:00+Z).'."\n" + .'>StartTime and EndTime must be provided together to define the query time window. An error is returned if either one is missing.>.', 'type' => 'string', 'required' => false, 'example' => '2018-11-29T00:00:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the task ends. Specify the time in the YYYY-MM-DDThh:mm:ssZ format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2019-12-06T12:00:00Z', - 'title' => '', - ], + 'schema' => ['description' => 'The end time in ISO 8601 format (for example, 2024-01-01T00:00:00+Z).'."\n" + .'>StartTime and EndTime must be provided together to define the query time window. An error is returned if either one is missing.>.', 'type' => 'string', 'required' => false, 'example' => '2019-12-06T12:00:00Z', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The task type. Valid values:'."\n" - ."\n" - .'* **file**: purges the cache by file URL.'."\n" - .'* **preload**: prefetches files.'."\n" - .'* **directory**: purges the cache by directory.'."\n" - .'* **ignoreparams**: purges the cache by URL with specified parameters ignored.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'file', - 'title' => '', - ], + 'schema' => ['description' => 'The task type. Valid values:'."\n" + ."\n" + .'- **file**: URL file purge.'."\n" + .'- **preload**: resource prefetch.'."\n" + .'- **directory**: directory purge.'."\n" + .'- **ignoreparams**: purge with parameters ignored.', 'type' => 'string', 'required' => false, 'example' => 'file', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6D****', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6D****'], 'Tasks' => [ - 'description' => 'The file upload tasks.'."\n", + 'description' => 'The list of file upload tasks.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'UploadTaskName' => [ - 'description' => 'The name of the file upload task.'."\n", - 'type' => 'string', - 'example' => 'purge_file_task', - 'title' => '', - ], - 'UploadId' => [ - 'description' => 'The ID of the file upload task.'."\n", - 'type' => 'string', - 'example' => '159253299357****', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the task was created.'."\n", - 'type' => 'string', - 'example' => '2023-07-26T01:56:15Z', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The task status.'."\n" - ."\n" - .'* **Complete**: The task is complete.'."\n" - .'* **Refreshing**: The task is in progress.'."\n" - .'* **Failed**: The task failed.'."\n", - 'type' => 'string', - 'example' => 'Complete', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The task type. Valid values:'."\n" - ."\n" - .'* **file**: purges the cache by file URL.'."\n" - .'* **preload**: prefetches files.'."\n" - .'* **directory**: purges the cache by directory.'."\n" - .'* **ignoreparams**: purges the cache by URL with specified parameters ignored.'."\n", - 'type' => 'string', - 'example' => 'file', - 'title' => '', - ], - 'Description' => [ - 'description' => 'The error message returned when the file upload task failed.'."\n", - 'type' => 'string', - 'example' => 'invalid url', - 'title' => '', - ], - 'ErrorCode' => [ - 'description' => 'The error code. Multiple error codes are separated by commas (,).'."\n" - ."\n" - .'* **InvalidUrl**: The URL format is incorrect.'."\n" - .'* **InvalidDomain**: The domain ownership fails to be verified.'."\n" - .'* **QuotaExcess**: The quota limit has been reached.'."\n" - .'* **OtherErrors**: Other errors.'."\n", - 'type' => 'string', - 'example' => 'InvalidUrl,InvalidDomain', - 'title' => '', - ], + 'UploadTaskName' => ['description' => 'The name of the file upload task.', 'type' => 'string', 'example' => 'purge_file_task', 'title' => ''], + 'UploadId' => ['description' => 'The ID of the file upload task.', 'type' => 'string', 'example' => '159253299357****', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time in ISO 8601 format (for example, 2024-01-01T00:00:00+Z).', 'type' => 'string', 'example' => '2023-07-26T01:56:15Z', 'title' => ''], + 'Status' => ['description' => 'The task status. Valid values:'."\n" + .'- **Complete**: The task is complete.'."\n" + .'- **Refreshing**: The task is in progress.'."\n" + .'- **Failed**: The task failed.', 'type' => 'string', 'example' => 'Complete', 'title' => ''], + 'Type' => ['description' => 'The task type. Valid values:'."\n" + ."\n" + .'- **file**: URL file purge.'."\n" + .'- **preload**: resource prefetch.'."\n" + .'- **directory**: directory purge.'."\n" + .'- **ignoreparams**: purge with parameters ignored.', 'type' => 'string', 'example' => 'file', 'title' => ''], + 'Description' => ['description' => 'The error message returned when the file upload task fails.', 'type' => 'string', 'example' => 'invalid url', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code. Multiple error codes are separated by commas. Valid values:'."\n" + ."\n" + .'- **InvalidUrl**: The URL format is invalid.'."\n" + .'- **InvalidDomain**: The domain name ownership verification failed.'."\n" + .'- **QuotaExcess**: The quota limit is exceeded.'."\n" + .'- **OtherErrors**: Other errors occurred.', 'type' => 'string', 'example' => 'InvalidUrl,InvalidDomain', 'title' => ''], ], 'description' => '', 'title' => '', @@ -69884,102 +39190,37 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingTimeParameter', - 'errorMessage' => 'The StartTime and EndTime must be both specified.', - 'description' => 'Please provide both a start time and an end time.', - ], - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], - [ - 'errorCode' => 'DomainNameOverLimit', - 'errorMessage' => 'A maximum of 500 domains are supported for each request.', - 'description' => 'Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.', - ], - [ - 'errorCode' => 'InvalidTime', - 'errorMessage' => 'The query time cannot exceed the last 3 days.', - 'description' => 'The query time cannot exceed the last 3 days.', - ], - [ - 'errorCode' => 'MissingParameter.ObjectType', - 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', - 'description' => 'Specify the ObjectType parameter.', - ], - [ - 'errorCode' => 'InvalidStationParameter', - 'errorMessage' => 'The specified Station is invalid.', - 'description' => 'The specified node parameter is invalid.', - ], - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests.Please try again later.', - 'description' => 'Requests are too frequent, please try again later.', - ], - [ - 'errorCode' => 'InvalidTaskId.Malformed', - 'errorMessage' => 'The specified taskId is invalid.', - 'description' => 'The specified task ID is invalid.', - ], - [ - 'errorCode' => 'InvalidParameters.InvalidUrls', - 'errorMessage' => 'The specified urls are invalid.', - 'description' => 'The requested URL parameter is invalid.', - ], + ['errorCode' => 'MissingTimeParameter', 'errorMessage' => 'The StartTime and EndTime must be both specified.', 'description' => 'Please provide both a start time and an end time.'], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'DomainNameOverLimit', 'errorMessage' => 'A maximum of 500 domains are supported for each request.', 'description' => 'Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.'], + ['errorCode' => 'InvalidTime', 'errorMessage' => 'The query time cannot exceed the last 3 days.', 'description' => 'The query time cannot exceed the last 3 days.'], + ['errorCode' => 'MissingParameter.ObjectType', 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', 'description' => 'Specify the ObjectType parameter.'], + ['errorCode' => 'InvalidStationParameter', 'errorMessage' => 'The specified Station is invalid.', 'description' => 'The specified node parameter is invalid.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], + ['errorCode' => 'InvalidTaskId.Malformed', 'errorMessage' => 'The specified taskId is invalid.', 'description' => 'The specified task ID is invalid.'], + ['errorCode' => 'InvalidParameters.InvalidUrls', 'errorMessage' => 'The specified urls are invalid.', 'description' => 'The requested URL parameter is invalid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], '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"}]', - 'title' => 'ListUploadTasks', + 'title' => 'List file upload tasks', '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}', - ], - ], - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUploadTasks'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], + 'ramActions' => [], ], 'ListUrlObservations' => [ - 'summary' => 'Queries the list of page monitoring configurations.', + 'summary' => 'Queries the list of web page observation configurations.', 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -69992,102 +39233,51 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '264797', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '34003500310****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can obtain this value by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '34003500310****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration ID,'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '35281609698****', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The page number. Page starts from page 1. Default value: 1'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number for a paged query. The value must be greater than or equal to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The number of entries per page. Default value: **500**. Valid values: **1 to 500**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page for a paged query. Valid values: 1 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74'], 'Configs' => [ - 'description' => 'The configurations of the feature.'."\n", + 'description' => 'The configuration data.', 'type' => 'array', 'items' => [ - 'description' => 'The details about the configurations.'."\n", + 'description' => 'The configuration details.', 'type' => 'object', 'properties' => [ - 'ConfigId' => [ - 'description' => 'The configuration ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '35281609698****'."\n", - 'title' => '', - ], - 'Url' => [ - 'description' => 'The URL of the web page to monitor.'."\n", - 'type' => 'string', - 'example' => 'example.com/test', - 'title' => '', - ], - 'SdkType' => [ - 'description' => 'SDK integration. Valid values:'."\n" - ."\n" - .'* **automatic**'."\n" - .'* **manual**'."\n", - 'type' => 'string', - 'example' => 'manual', - 'title' => '', - ], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '35281609698****'."\n", 'title' => ''], + 'Url' => ['description' => 'The URL of the web page to monitor.', 'type' => 'string', 'example' => 'example.com/test', 'title' => ''], + 'SdkType' => ['description' => 'The SDK integration method. Valid values:'."\n" + ."\n" + .'- **automatic**: Automatic integration.'."\n" + .'- **manual**: Manual integration.', 'type' => 'string', 'example' => 'manual', 'title' => ''], ], 'title' => '', 'example' => '', @@ -70095,34 +39285,10 @@ 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'description' => 'The number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'TotalPage' => [ - 'description' => 'The total number of pages returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], + 'PageNumber' => ['description' => 'The current page number, which is the same as the PageNumber request parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'example' => '', ], @@ -70130,32 +39296,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', - 'title' => 'ListUrlObservations', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'Query web page monitoring configurations', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListUrlObservations', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUrlObservations'], ], ], 'ramActions' => [ @@ -70166,12 +39320,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -70179,12 +39328,8 @@ ], 'ListUserDeliveryTasks' => [ 'summary' => 'Queries all delivery tasks in your Alibaba Cloud account by page. You can filter the delivery tasks by the category of the delivered real-time logs.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -70197,9 +39342,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239264', - 'abilityTreeNodes' => [ - 'FEATUREdcdn9K10I1', - ], + 'abilityTreeNodes' => ['FEATUREdcdn9K10I1'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ @@ -70207,42 +39350,22 @@ 'name' => 'BusinessType', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '', - 'description' => 'The log category. Valid values:'."\n" - ."\n" - .'1. dcdn_log_access_l1 (default): access logs.'."\n" - .'2. dcdn_log_er: Edge Routine logs.'."\n" - .'3. dcdn_log_waf: firewall logs.'."\n" - .'4. dcdn_log_ipa: TCP/UDP proxy logs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dcdn_log_access_l1', - ], + 'schema' => ['title' => '', 'description' => 'The log category. Valid values:'."\n" + ."\n" + .'1. dcdn_log_access_l1 (default): access logs.'."\n" + .'2. dcdn_log_er: Edge Routine logs.'."\n" + .'3. dcdn_log_waf: firewall logs.'."\n" + .'4. dcdn_log_ipa: TCP/UDP proxy logs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dcdn_log_access_l1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 20.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -70252,72 +39375,24 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1f94c47f-3a1a-4f69-8d6c-bfeee1b49aab', - ], - 'TotalCount' => [ - 'description' => 'The total number of delivery tasks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '68', - 'title' => '', - ], - 'PageNumber' => [ - 'description' => 'The page number returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1f94c47f-3a1a-4f69-8d6c-bfeee1b49aab'], + 'TotalCount' => ['description' => 'The total number of delivery tasks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '68', 'title' => ''], + 'PageNumber' => ['description' => 'The page number returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'Tasks' => [ 'description' => 'The delivery tasks.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'TaskName' => [ - 'description' => 'The name of the delivery task.'."\n", - 'type' => 'string', - 'example' => 'testoss11', - 'title' => '', - ], - 'DeliveryType' => [ - 'description' => 'The delivery destination.'."\n", - 'type' => 'string', - 'example' => 'oss', - 'title' => '', - ], - 'DataCenter' => [ - 'description' => 'The data center. Valid values:'."\n" - ."\n" - .'1. cn: the Chinese mainland.'."\n" - .'2. sg: outside the Chinese mainland.'."\n", - 'type' => 'string', - 'example' => 'cn', - 'title' => '', - ], - 'BusinessType' => [ - 'description' => 'The log category.'."\n", - 'type' => 'string', - 'example' => 'dcdn_log_er', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the delivery task.'."\n", - 'type' => 'string', - 'example' => 'online', - 'title' => '', - ], + 'TaskName' => ['description' => 'The name of the delivery task.'."\n", 'type' => 'string', 'example' => 'testoss11', 'title' => ''], + 'DeliveryType' => ['description' => 'The delivery destination.'."\n", 'type' => 'string', 'example' => 'oss', 'title' => ''], + 'DataCenter' => ['description' => 'The data center. Valid values:'."\n" + ."\n" + .'1. cn: the Chinese mainland.'."\n" + .'2. sg: outside the Chinese mainland.'."\n", 'type' => 'string', 'example' => 'cn', 'title' => ''], + 'BusinessType' => ['description' => 'The log category.'."\n", 'type' => 'string', 'example' => 'dcdn_log_er', 'title' => ''], + 'Status' => ['description' => 'The status of the delivery task.'."\n", 'type' => 'string', 'example' => 'online', 'title' => ''], ], 'description' => '', 'title' => '', @@ -70333,48 +39408,23 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], ], 403 => [ - [ - 'errorCode' => 'EsaService.NotOpen', - 'errorMessage' => 'ESA service has not opend.', - 'description' => 'Edge Security Accelerator (ESA) is not turned on', - ], + ['errorCode' => 'EsaService.NotOpen', 'errorMessage' => 'ESA service has not opend.', 'description' => 'Edge Security Accelerator (ESA) is not turned on'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'ListUserDeliveryTasks', 'changeSet' => [ - [ - 'createdAt' => '2024-10-18T01:07:11.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-27T05:57:02.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-10-18T01:07:11.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-27T05:57:02.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListUserDeliveryTasks', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserDeliveryTasks'], ], ], 'ramActions' => [ @@ -70385,25 +39435,16 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListUserRatePlanInstances' => [ - 'summary' => 'Queries the plans that you purchased and the details of the plans.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the plan instances purchased by the user and their details.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -70416,9 +39457,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239044', - 'abilityTreeNodes' => [ - 'FEATUREdcdnZA9EPX', - ], + 'abilityTreeNodes' => ['FEATUREdcdnZA9EPX'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ @@ -70426,17 +39465,15 @@ 'name' => 'CheckRemainingSiteQuota', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to query only the plans that have remaining quota for associating websites. Valid values:'."\n" + 'description' => 'Specifies whether to filter plan instances that have remaining site quota. Valid values:'."\n" ."\n" - .'* true: queries only the plans that have remaining quota for associating websites.'."\n" - .'* false: queries all plans in your account.'."\n", + .'- **true**: Filters plan instances that have remaining site quota.'."\n" + .'- **false**: Queries all plan instances under the user.', + 'enumValueTitles' => [], 'type' => 'string', + 'enum' => ['true', 'false'], 'required' => false, 'example' => 'true', - 'enum' => [ - 'true', - 'false', - ], 'title' => '', ], ], @@ -70445,22 +39482,16 @@ 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ - 'description' => 'The plan status. Valid values:'."\n" - ."\n" - .'* online: The plan is in service.'."\n" - .'* offline: The plan has expired within an allowable period. In this state, the plan is unavailable.'."\n" - .'* disable: The plan is released.'."\n" - .'* overdue: The plan is stopped due to overdue payments.'."\n", + 'description' => 'The instance status. Valid values:'."\n" + .'- **online**: The plan instance is in normal service.'."\n" + .'- **offline**: The plan instance has expired but has not exceeded the grace period and is not active.'."\n" + .'- **disable**: The plan instance has been released.'."\n" + .'- **overdue**: The plan instance has an overdue payment.', + 'enumValueTitles' => [], 'type' => 'string', + 'enum' => ['online', 'offline', 'disable', 'all', 'overdue'], 'required' => false, 'example' => 'online', - 'enum' => [ - 'online', - 'offline', - 'disable', - 'all', - 'overdue', - ], 'title' => '', ], ], @@ -70469,18 +39500,15 @@ 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ - 'description' => 'The sorting field. By default, the queried plans are sorted by purchase time. Valid values:'."\n" + 'description' => 'The field by which to sort the results. By default, results are sorted by purchase time. Valid values:'."\n" ."\n" - .'* CreateTime: the time when the plans were purchased.'."\n" - .'* ExpireTime: the time when the plans expire.'."\n", + .'- **CreateTime**: purchase time.'."\n" + .'- **ExpireTime**: expiration time.', + 'enumValueTitles' => [], 'type' => 'string', + 'enum' => ['ExpireTime', 'CreateTime', 'default'], 'required' => false, 'example' => 'CreateTime', - 'enum' => [ - 'ExpireTime', - 'CreateTime', - 'default', - ], 'title' => '', ], ], @@ -70489,193 +39517,110 @@ 'in' => 'query', 'schema' => [ 'title' => '', - 'description' => 'The order in which you want to sort the query results. Default value: desc. Valid values:'."\n" + 'description' => 'The sort order. Default value: desc. Valid values:'."\n" ."\n" - .'* asc: in ascending order.'."\n" - .'* desc: in descending order.'."\n", + .'- **asc**: ascending order.'."\n" + .'- **desc**: descending order.', + 'enumValueTitles' => [], 'type' => 'string', + 'enum' => ['asc', 'desc'], 'required' => false, 'example' => 'asc', - 'enum' => [ - 'asc', - 'desc', - ], ], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Valid values: **1** to **100000**. Default value: **1**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number to return in a paged query. Default value: **1**. Valid values: **1** to **100000**. Settings for paging take effect only when this parameter is specified.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '500', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries per page in a paged query. Valid values: 1 to 500. This parameter is used for paging.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '500', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The plan ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sp-xcdn-96wblslz****', - 'title' => '', - ], + 'schema' => ['description' => 'The plan instance ID. You can obtain the ID by calling the [ListSites](~~2850189~~) operation.', 'type' => 'string', 'required' => false, 'example' => 'sp-xcdn-96wblslz****', 'title' => ''], ], [ 'name' => 'RemainingExpireDays', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'exclusiveMinimum' => false, - 'required' => false, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'Queries plan instances whose remaining validity period is within the specified number of days. The value must be a positive integer. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'exclusiveMinimum' => false, 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'SubscribeType', 'in' => 'query', 'schema' => [ + 'description' => 'The plan subscription type. Valid values:'."\n" + ."\n" + .'- entranceplan: Free Edition (Chinese mainland)'."\n" + .'- entranceplan_intl: Free Edition (International)'."\n" + .'- basicplan: Basic Edition'."\n" + .'- standardplan: Standard Edition'."\n" + .'- advancedplan: Premium Edition'."\n" + .'- enterpriseplan: Enterprise Edition.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'enum' => [ - 'entranceplan', - 'basicplan', - 'standardplan', - 'advancedplan', - 'enterpriseplan', - ], - 'description' => '', + 'enum' => ['entranceplan', 'basicplan', 'standardplan', 'advancedplan', 'enterpriseplan'], + 'example' => 'basicplan', 'title' => '', - 'example' => '', ], ], [ 'name' => 'PlanType', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The plan type. Valid values:'."\n" + ."\n" + .'- normal: fixed-version plan'."\n" + .'- enterprise: Enterprise Edition plan.', 'type' => 'string', 'required' => false, 'example' => 'enterprise', 'title' => ''], + ], + [ + 'name' => 'PlanNameEn', + 'in' => 'query', + 'schema' => ['description' => 'The plan name in English.', 'type' => 'string', 'required' => false, 'example' => 'entranceplan', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE'], 'InstanceInfo' => [ - 'description' => 'The queried plans.'."\n", + 'description' => 'The plan instances that match the specified conditions under the user.', 'type' => 'array', 'items' => [ - 'description' => 'The details of the plan.'."\n", + 'description' => 'The details of the plan instance.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => 'The plan ID.'."\n", - 'type' => 'string', - 'example' => 'sp-xcdn-96wblslz****', - 'title' => '', - ], - 'PlanName' => [ - 'description' => 'The plan name.'."\n", - 'type' => 'string', - 'example' => 'basic', - 'title' => '', - ], - 'PlanType' => [ - 'description' => 'The plan type. Valid values:'."\n" - ."\n" - .'* normal'."\n" - .'* enterprise'."\n", - 'type' => 'string', - 'example' => 'normal', - 'title' => '', - ], - 'SiteQuota' => [ - 'description' => 'The maximum number of websites that can be associated with the plan.'."\n", - 'type' => 'string', - 'example' => '1', - 'title' => '', - ], - 'ExpireTime' => [ - 'description' => 'The time when the plan expires.'."\n", - 'type' => 'string', - 'example' => 'YYYY-MM-DDThh:mm:ssZ ', - 'title' => '', - ], - 'Duration' => [ - 'description' => 'The subscription duration of the plan. Unit: month.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the plan was purchased.'."\n", - 'type' => 'string', - 'example' => 'YYYY-MM-DDThh:mm:ssZ ', - 'title' => '', - ], + 'InstanceId' => ['description' => 'The plan instance ID.', 'type' => 'string', 'example' => 'sp-xcdn-96wblslz****', 'title' => ''], + 'PlanName' => ['description' => 'The plan name associated with the plan instance.', 'type' => 'string', 'example' => 'basic', 'title' => ''], + 'PlanType' => ['description' => 'The plan type associated with the plan instance. Valid values:'."\n" + .'- **normal**: fixed-version plan.'."\n" + .'- **enterprise**: Enterprise Edition plan.', 'type' => 'string', 'example' => 'normal', 'title' => ''], + 'SiteQuota' => ['description' => 'The site quota for the plan instance.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ExpireTime' => ['description' => 'The expiration time of the plan instance. The time is in ISO 8601 format and displayed in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2026-04-19T11:15:20Z', 'title' => ''], + 'Duration' => ['description' => 'The subscription duration of the plan instance. Unit: months.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'CreateTime' => ['description' => 'The purchase time of the plan instance. The time is in ISO 8601 format and displayed in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2026-04-19T11:15:20Z', 'title' => ''], 'Sites' => [ - 'description' => 'The websites that have been associated with the plan.'."\n", + 'description' => 'The list of sites bound to the current plan instance.', 'type' => 'array', 'items' => [ - 'description' => 'The details of the associated website.'."\n", + 'description' => 'The details of the bound site.', 'type' => 'object', 'properties' => [ - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456****', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com', - 'title' => '', - ], - 'SiteStatus' => [ - 'description' => 'The website status. Valid values:'."\n" - ."\n" - .'* pending: The website is to be configured.'."\n" - .'* active: The website is active.'."\n" - .'* offline: The website is suspended.'."\n" - .'* moved: The website has been added and verified by another Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => 'pending', - 'title' => '', - ], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456****', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'SiteStatus' => ['description' => 'The site status. Valid values:'."\n" + ."\n" + .'- **pending**: The site is pending configuration.'."\n" + .'- **active**: The site is activated.'."\n" + .'- **offline**: The site is offline.'."\n" + .'- **moved**: The site has been superseded.', 'type' => 'string', 'example' => 'pending', 'title' => ''], ], 'title' => '', 'example' => '', @@ -70683,119 +39628,50 @@ 'title' => '', 'example' => '', ], - 'Status' => [ - 'description' => 'The plan status. Valid values:'."\n" - ."\n" - .'* online: The plan is in service.'."\n" - .'* offline: The plan has expired within an allowable period. In this state, the plan is unavailable.'."\n" - .'* disable: The plan is released.'."\n", - 'type' => 'string', - 'example' => 'online', - 'title' => '', - ], - 'Coverages' => [ - 'description' => 'The service locations for the websites that can be associated with the plan. Multiple values are separated by commas (,). Valid values:'."\n" - ."\n" - .'* domestic: the Chinese mainland.'."\n" - .'* overseas: outside the Chinese mainland.'."\n" - .'* global: global.'."\n", - 'type' => 'string', - 'example' => 'domestic,overseas', - 'title' => '', - ], - 'BillingMode' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* PREPAY: subscription.'."\n" - .'* POSTPAY: pay-as-you-go.'."\n", - 'type' => 'string', - 'example' => 'PREPAY', - 'title' => '', - ], - 'PlanTraffic' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'Layer4Traffic' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'Layer4TrafficIntl' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'CrossborderTraffic' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'EdgeRoutineRquest' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'StaticRequest' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'SmartRoutingRequest' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'EdgeWafRequest' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'DdosInstanceLevel' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'DdosBurstableDomesticProtection' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'DdosBurstableOverseasProtection' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'BotInstanceLevel' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'BotRequest' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'SubscribeType' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'Status' => ['description' => 'The instance status. Valid values:'."\n" + .'- **online**: The plan instance is in normal service.'."\n" + .'- **offline**: The plan instance has expired but has not exceeded the grace period and is not active.'."\n" + .'- **disable**: The plan instance has been released.', 'type' => 'string', 'example' => 'online', 'title' => ''], + 'Coverages' => ['description' => 'The acceleration regions to which sites can be bound under this plan instance. Multiple values are separated by commas (,). Valid values:'."\n" + ."\n" + .'- **domestic**: China or the Chinese mainland.'."\n" + .'- **overseas**: Global (excluding China or the Chinese mainland).'."\n" + .'- **global**: Global (including China or the Chinese mainland).', 'type' => 'string', 'example' => 'domestic,overseas', 'title' => ''], + 'BillingMode' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- **PREPAY**: subscription.'."\n" + .'- **POSTPAY**: pay-as-you-go.', 'type' => 'string', 'example' => 'PREPAY', 'title' => ''], + 'PlanTraffic' => ['description' => 'The prepaid Layer 7 acceleration traffic included in the plan, in GB.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'Layer4Traffic' => ['description' => 'The prepaid Layer 4 proxy traffic included in the plan, in GB, for the Chinese mainland.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'Layer4TrafficIntl' => ['description' => 'The prepaid Layer 4 proxy traffic included in the plan, in GB, outside the Chinese mainland.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'CrossborderTraffic' => ['description' => 'The prepaid China network acceleration traffic included in the plan, in GB.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'EdgeRoutineRquest' => ['description' => 'The prepaid Edge Routine (ER) requests included in the plan, in units of 10,000.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'StaticRequest' => ['description' => 'The prepaid HTTP requests included in the plan, in units of 10,000.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'SmartRoutingRequest' => ['description' => 'The prepaid smart routing requests included in the plan, in units of 10,000.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'EdgeWafRequest' => ['description' => 'The prepaid WAF requests included in the plan, in units of 10,000.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'DdosInstanceLevel' => ['description' => 'If this field is empty, the plan does not include an Anti-DDoS instance. If a value is returned, the plan includes an Anti-DDoS instance. The value is `esa_ddos_instance`.', 'type' => 'string', 'example' => 'esa_ddos_instance', 'title' => ''], + 'DdosBurstableDomesticProtection' => ['description' => 'The Anti-DDoS instance specification for the Chinese mainland included in the plan.', 'type' => 'string', 'example' => 'cn_300', 'title' => ''], + 'DdosBurstableOverseasProtection' => ['description' => 'The Anti-DDoS instance specification outside the Chinese mainland included in the plan.', 'type' => 'string', 'example' => 'overseas_300', 'title' => ''], + 'BotInstanceLevel' => ['description' => 'If this field is empty, the plan does not include a bot protection instance. If a value is returned, the plan includes a bot protection instance. Valid values:'."\n" + ."\n" + .'- enterprise_bot: Web Edition'."\n" + ."\n" + .'- enterprise_bot_with_app: App Edition.', 'type' => 'string', 'example' => 'enterprise_bot', 'title' => ''], + 'BotRequest' => ['description' => 'The prepaid bot protection requests included in the plan, in units of 10,000.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'SubscribeType' => ['description' => 'The plan subscription type. Valid values:'."\n" + ."\n" + .'- entranceplan: Free Edition (Chinese mainland)'."\n" + .'- entranceplan_intl: Free Edition (International)'."\n" + .'- basicplan: Basic Edition'."\n" + .'- standardplan: Standard Edition'."\n" + .'- advancedplan: Premium Edition'."\n" + .'- enterpriseplan: Enterprise Edition.', 'type' => 'string', 'example' => 'basicplan', 'title' => ''], + 'RenewalStatus' => ['title' => '', 'description' => 'The auto-renewal status. Valid values:'."\n" + ."\n" + .'- nomal: normal'."\n" + .'- auto_renewal: auto-renewal enabled'."\n" + .'- not_renewal: auto-renewal disabled.', 'type' => 'string', 'example' => 'nomal'], + 'RenewalDuration' => ['title' => '', 'description' => 'The auto-renewal cycle. Unit: months.', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], ], 'title' => '', 'example' => '', @@ -70803,34 +39679,10 @@ 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '68', - 'title' => '', - ], - 'TotalPage' => [ - 'description' => 'The total number of pages returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], + 'PageNumber' => ['description' => 'The current page number, which is the same as the PageNumber request parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '68', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'example' => '', ], @@ -70838,48 +39690,22 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'ListUserRatePlanInstances', + 'staticInfo' => ['returnType' => 'synchronous'], + '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\\": \\"2026-04-19T11:15:20Z\\",\\n \\"Duration\\": 3,\\n \\"CreateTime\\": \\"2026-04-19T11:15:20Z\\",\\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\\": \\"100\\",\\n \\"Layer4Traffic\\": \\"100\\",\\n \\"Layer4TrafficIntl\\": \\"100\\",\\n \\"CrossborderTraffic\\": \\"100\\",\\n \\"EdgeRoutineRquest\\": \\"100\\",\\n \\"StaticRequest\\": \\"100\\",\\n \\"SmartRoutingRequest\\": \\"100\\",\\n \\"EdgeWafRequest\\": \\"100\\",\\n \\"DdosInstanceLevel\\": \\"esa_ddos_instance\\",\\n \\"DdosBurstableDomesticProtection\\": \\"cn_300\\",\\n \\"DdosBurstableOverseasProtection\\": \\"overseas_300\\",\\n \\"BotInstanceLevel\\": \\"enterprise_bot\\",\\n \\"BotRequest\\": \\"100\\",\\n \\"SubscribeType\\": \\"basicplan\\",\\n \\"RenewalStatus\\": \\"nomal\\",\\n \\"RenewalDuration\\": 6\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 68,\\n \\"TotalPage\\": 1\\n}","type":"json"}]', + 'title' => 'Query user plan instances', 'changeSet' => [ - [ - 'createdAt' => '2025-02-12T02:01:32.000Z', - 'description' => 'Request parameters changed, Response parameters changed', - ], - [ - 'createdAt' => '2025-01-10T01:51:17.000Z', - 'description' => 'Response parameters changed', - ], - [ - 'createdAt' => '2024-11-28T06:41:41.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-11-12T05:57:29.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-02-12T02:01:32.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-01-10T01:51:17.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-28T06:41:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-12T05:57:29.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListUserRatePlanInstances', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserRatePlanInstances'], ], ], 'ramActions' => [ @@ -70890,28 +39716,16 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', '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' => 'Queries the functions created in your account and the maximum number of functions supported by your plan. You can call this operation to perform a paged query.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Retrieves a paginated list of Edge Routines created by the user along with quota information.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -70924,133 +39738,51 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238899', - 'abilityTreeNodes' => [ - 'FEATUREdcdn75UYDO', - ], + 'abilityTreeNodes' => ['FEATUREdcdn75UYDO'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the returned page. Default value: 1. Valid values: 1 to 10.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The page number. Default value: 1. Maximum value: 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 20.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 20.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'SearchKeyWord', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword used for fuzzy search.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hello', - 'title' => '', - ], + 'schema' => ['description' => 'The keyword for fuzzy match.', 'type' => 'string', 'required' => false, 'example' => 'hello', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1234567890ABCDEF', - ], - 'PageNumber' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total count.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - 'title' => '', - ], - 'QuotaRoutineNumber' => [ - 'description' => 'The maximum number of functions supported by the billing plan.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - 'title' => '', - ], - 'UsedRoutineNumber' => [ - 'description' => 'The number of functions that were already created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1234567890ABCDEF'], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'QuotaRoutineNumber' => ['description' => 'The Routine quota for the current plan.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'UsedRoutineNumber' => ['description' => 'The number of Routines already created.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], 'Routines' => [ - 'description' => 'The functions.'."\n", + 'description' => 'The list of Routines.', 'type' => 'array', 'items' => [ - 'description' => 'The functions.'."\n", + 'description' => 'The array of Routine entries.', 'type' => 'object', 'properties' => [ - 'RoutineName' => [ - 'description' => 'The function name.'."\n", - 'type' => 'string', - 'example' => 'hello', - 'title' => '', - ], - 'Description' => [ - 'description' => 'The function description.'."\n", - 'type' => 'string', - 'example' => 'ZWRpdCByb3V0aW5lIGNvbmZpZyBkZXNjcmlwdGlvbg==', - 'title' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the function was created.'."\n", - 'type' => 'string', - 'example' => '2024-03-11T01:23:02.883361712Z', - 'title' => '', - ], - 'HasAssets' => [ - 'description' => 'Specifies whether to include the Assets file tag.'."\n", - 'type' => 'boolean', - 'example' => 'false', - 'title' => '', - ], - 'DefaultRelatedRecord' => [ - 'description' => 'The default record name to access.'."\n", - 'type' => 'string', - 'example' => 'serverless-test-2.154edaf6.er.aliyun-esa.net', - 'title' => '', - ], + 'RoutineName' => ['description' => 'The Routine name.', 'type' => 'string', 'example' => 'hello', 'title' => ''], + 'Description' => ['description' => 'The Routine description.', 'type' => 'string', 'example' => 'ZWRpdCByb3V0aW5lIGNvbmZpZyBkZXNjcmlwdGlvbg==', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the Edge Routine was created. The time follows the RFC 3339 standard in the UTC time zone.', 'type' => 'string', 'example' => '2024-03-11T01:23:02.883361712Z', 'title' => ''], + 'HasAssets' => ['description' => 'Indicates whether the Routine contains asset files.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'DefaultRelatedRecord' => ['description' => 'The default access record associated with the Routine.', 'type' => 'string', 'example' => 'serverless-test-2.154edaf6.er.aliyun-esa.net', 'title' => ''], ], 'title' => '', 'example' => '', @@ -71065,73 +39797,40 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalOperationError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'ParameterNotExist', - 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', - 'description' => 'The specified parameter does not exist. Check your configurations and try again.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalOperationError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'ParameterNotExist', 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', 'description' => 'The specified parameter does not exist. Check your configurations and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', - 'title' => 'ListUserRoutines', - 'description' => '该接口允许用户分页查询其账户下创建的所有边缘函数（Routine）列表，并提供当前套餐的Routine配额数量及已使用的数量。用户可以通过指定分页参数`PageNumber`和`PageSize`来控制返回结果的数量，使用`SearchKeyWord`进行模糊搜索以过滤特定的Routine名称。', + 'title' => 'Query user routine list', + 'description' => 'This operation allows you to perform a paged query for all Edge Routines created under your account. It also returns the Edge Routine quota for your current plan and the number of Edge Routines already in use. You can specify the PageNumber and PageSize paging parameters to control the number of results returned, and use SearchKeyWord to perform a fuzzy search to filter Routine names.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListUserRoutines', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserRoutines'], ], ], 'ramActions' => [ [ - 'operationType' => 'none', + 'operationType' => 'list', 'ramAction' => [ 'action' => 'esa:ListUserRoutines', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListUserWafRulesets' => [ - 'summary' => 'Queries the WAF rulesets for a specified instance. You can filter the results by phase, name, and other criteria.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Retrieves WAF rule sets for a specified instance, allowing filtering by phase, name, and other criteria.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -71144,40 +39843,34 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239588', - 'abilityTreeNodes' => [ - 'FEATUREdcdnV3YEJ8', - 'FEATUREdcdnUTRW1O', - 'FEATUREdcdnSU2QP6', - 'FEATUREdcdnV3G3FZ', - 'FEATUREdcdnBQ0J3E', - ], + 'abilityTreeNodes' => ['FEATUREdcdnV3YEJ8', 'FEATUREdcdnUTRW1O', 'FEATUREdcdnSU2QP6', 'FEATUREdcdnV3G3FZ', 'FEATUREdcdnBQ0J3E'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'esa-xxxxxxx', - 'title' => '', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'esa-xxxxxxx', 'title' => ''], ], [ 'name' => 'Phase', 'in' => 'query', - 'schema' => [ - 'description' => 'The WAF phase.', - 'type' => 'string', - 'example' => '● 自定义规则 - http_custom'."\n" - .'● 频次控制规则 - http_ratelimit'."\n" - .'● 托管规则 - http_managed'."\n" - .'● 白名单规则 - http_whitelist'."\n" - .'● 扫描防护规则 - http_anti_scan', - 'title' => '', - 'required' => false, - ], + 'schema' => ['description' => 'Specifies the execution phase of the WAF rule.'."\n" + ."\n" + .'- `http_whitelist`: whitelist rule'."\n" + ."\n" + .'- `http_custom`: custom rule'."\n" + ."\n" + .'- `http_managed`: managed rule'."\n" + ."\n" + .'- `http_anti_scan`: anti-scan rule'."\n" + ."\n" + .'- `http_ratelimit`: rate limit rule'."\n" + ."\n" + .'- `ip_access_rule`: IP access rule'."\n" + ."\n" + .'- `http_bot`: advanced mode bot'."\n" + ."\n" + .'- `http_security_level_rule`: security rule', 'type' => 'string', 'example' => 'http_custom', 'title' => '', 'required' => false], ], [ 'name' => 'QueryArgs', @@ -71186,30 +39879,12 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'NameLike' => [ - 'description' => 'The keyword for a fuzzy search by ruleset name.', - 'type' => 'string', - 'example' => 'example', - 'title' => '', - 'required' => false, - ], - 'OrderBy' => [ - 'description' => 'The column to use for sorting.', - 'type' => 'string', - 'example' => 'id', - 'title' => '', - 'required' => false, - ], - 'Desc' => [ - 'description' => 'Specifies whether to sort the results in descending order.', - 'type' => 'boolean', - 'title' => '', - 'required' => false, - 'example' => '', - ], + 'NameLike' => ['description' => 'A string for a fuzzy search of ruleset names.', 'type' => 'string', 'example' => 'example', 'title' => '', 'required' => false], + 'OrderBy' => ['description' => 'The field by which to sort results.', 'type' => 'string', 'example' => 'id', 'title' => '', 'required' => false], + 'Desc' => ['description' => 'Specifies whether to sort results in descending order.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => ''], ], 'title' => '', - 'description' => 'The query parameters.', + 'description' => 'Parameters for filtering and sorting the results.', 'required' => false, 'example' => '', ], @@ -71217,26 +39892,12 @@ [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - 'required' => false, - ], + 'schema' => ['description' => 'The page number to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - 'required' => false, - ], + 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => '', 'required' => false], ], ], 'responses' => [ @@ -71244,92 +39905,47 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - 'title' => '', - ], - 'InstanceUsage' => [ - 'description' => 'The instance usage.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of records after filtering.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', 'title' => ''], + 'InstanceUsage' => ['description' => 'The instance usage.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records after filtering.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], 'Rulesets' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The WAF ruleset ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000001', - 'title' => '', - ], - 'Position' => [ - 'description' => 'The position of the WAF ruleset.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'title' => '', - ], - 'Phase' => [ - 'description' => 'The WAF phase.', - 'type' => 'string', - 'example' => 'http_custom', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The name of the WAF ruleset.', - 'type' => 'string', - 'example' => 'example', - 'title' => '', - ], - 'Description' => [ - 'description' => 'The description of the WAF ruleset.', - 'type' => 'string', - 'example' => 'example', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the WAF ruleset.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], + 'Id' => ['description' => 'The WAF ruleset ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000001', 'title' => ''], + 'Position' => ['description' => 'The WAF ruleset position.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Phase' => ['description' => 'The WAF rule execution phase. Possible values:'."\n" + ."\n" + .'- `http_whitelist`: Whitelist rule'."\n" + ."\n" + .'- `http_custom`: Custom rule'."\n" + ."\n" + .'- `http_managed`: Managed rule'."\n" + ."\n" + .'- `http_anti_scan`: Scan protection rule'."\n" + ."\n" + .'- `http_ratelimit`: Rate limit rule'."\n" + ."\n" + .'- `ip_access_rule`: IP access rule'."\n" + ."\n" + .'- `http_bot`: Bot rule'."\n" + ."\n" + .'- `http_security_level_rule`: Security rule', 'type' => 'string', 'example' => 'http_custom', 'title' => ''], + 'Name' => ['description' => 'The WAF ruleset name.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'Description' => ['description' => 'The WAF ruleset description.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'Status' => ['description' => 'The WAF ruleset status.', 'type' => 'string', 'example' => 'on', 'title' => ''], ], 'title' => '', - 'description' => 'The WAF ruleset information.', + 'description' => 'A WAF ruleset object.', 'example' => '', ], 'title' => '', - 'description' => 'A list of WAF ruleset information.', + 'description' => 'A list of WAF ruleset objects.', 'example' => '', ], - 'PageNumber' => [ - 'description' => 'The page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], ], 'title' => '', 'description' => 'The response schema.', @@ -71339,33 +39955,23 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListUserWafRulesets', - 'description' => '## Request description'."\n" + 'description' => '## Request'."\n" ."\n" .'- `InstanceId` is a required parameter that specifies the WAF instance to query.'."\n" ."\n" - .'- The `Phase` parameter lets you filter rulesets based on different WAF processing phases, such as custom rules and rate limiting rules.'."\n" + .'- The `Phase` parameter filters rule sets by WAF processing phase, such as custom rules and rate limiting rules.'."\n" ."\n" - .'- You can use `NameLike` in `QueryArgs` to perform a fuzzy search for ruleset names.'."\n" + .'- Use `NameLike` in `QueryArgs` to perform a fuzzy search on rule set names.'."\n" ."\n" - .'- Paging is controlled by `PageNumber` and `PageSize`. Their default values are 1 and 20, respectively.'."\n" + .'- The `PageNumber` and `PageSize` parameters control pagination and default to 1 and 20, respectively.'."\n" ."\n" - .'- The response includes the request ID, current plan usage, total number of records, and a list of ruleset details.', + .'- The response includes the request ID, current plan usage, the total record count, and a list of rule set details.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -71378,12 +39984,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -71391,14 +39992,9 @@ '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' => [ - 'summary' => 'Queries the video processing configurations of a site.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries the list of video processing configurations for a site.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -71411,216 +40007,91 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257666', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12345', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration ID, You can call the [ListVideoProcessings](~~ListVideoProcessings~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID. You can call the [ListVideoProcessings](~~ListVideoProcessings~~) operation to obtain the configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '35281609698****', 'title' => ''], ], [ 'name' => 'ConfigType', 'in' => 'query', 'schema' => [ 'title' => '', - 'description' => 'The configuration type. Use this parameter to query global configurations or feature configurations. This parameter takes effect only if the functionName parameter is passed.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* global'."\n" - .'* rule'."\n", + 'description' => 'The configuration type. You can use this parameter to query global or rule configurations. This parameter takes effect only when functionName is specified.', + 'enumValueTitles' => ['rule' => 'rule configuration.', 'global' => 'global configuration.'], 'type' => 'string', + 'enum' => ['global', 'rule'], 'required' => false, - 'enum' => [ - 'global', - 'rule', - ], 'example' => 'global', ], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The rule name. This parameter takes effect only when parameter functionName is specified.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - ], + 'schema' => ['title' => '', 'description' => 'The rule name. You can use this parameter to query the rule that matches the specified name. This parameter takes effect only when functionName is specified.', 'type' => 'string', 'required' => false, 'example' => 'rule_example'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number for a paged query. The value must be greater than or equal to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The number of entries per page. Maximum value: 500. Default value: 500.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page for a paged query. Valid values: 1 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'], 'Configs' => [ - 'description' => 'The configurations.'."\n", + 'description' => 'The list of configurations.', 'type' => 'array', 'items' => [ - 'description' => 'The details about the configurations.'."\n", + 'description' => 'The configuration details.', 'type' => 'object', 'properties' => [ - 'ConfigId' => [ - 'description' => 'The configuration ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '234123**', - 'title' => '', - ], - 'SiteVersion' => [ - 'description' => 'The version number of the website configurations.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'The order in which the rule is executed. The smaller the value, the higher the priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Indicates whether the rule is enabled. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'The rule content.'."\n", - 'type' => 'string', - 'example' => '(http.host eq \\"video.example.com\\")'."\n", - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'The rule name.'."\n", - 'type' => 'string', - 'example' => 'rule_example', - 'title' => '', - ], - 'ConfigType' => [ - 'description' => 'The type of the configuration. Valid values:'."\n" - ."\n" - .'* global: global configuration.'."\n" - .'* rule: rule configuration.'."\n", - 'type' => 'string', - 'example' => 'global', - 'title' => '', - ], - 'VideoSeekEnable' => [ - 'description' => 'Video seeking. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'FlvVideoSeekMode' => [ - 'description' => 'FLV seeking. Valid values:'."\n" - ."\n" - .'* by_byte: Seek by byte.'."\n" - .'* by_time: Seek by time.'."\n", - 'type' => 'string', - 'example' => 'by_byte', - 'title' => '', - ], - 'Mp4SeekStart' => [ - 'description' => 'Customize the mp4 start parameter.'."\n", - 'type' => 'string', - 'example' => 'start', - 'title' => '', - ], - 'Mp4SeekEnd' => [ - 'description' => 'Customize the mp4 end parameter.'."\n", - 'type' => 'string', - 'example' => 'end', - 'title' => '', - ], - 'FlvSeekStart' => [ - 'description' => 'The custom start parameter for FLV files.'."\n", - 'type' => 'string', - 'example' => 'start', - 'title' => '', - ], - 'FlvSeekEnd' => [ - 'description' => 'The custom end parameter for FLV files.'."\n", - 'type' => 'string', - 'example' => 'end', - 'title' => '', - ], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '234123**', 'title' => ''], + 'SiteVersion' => ['description' => 'The version number of the site configuration.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Sequence' => ['description' => 'The execution order of the rule. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuleEnable' => ['description' => 'The rule switch. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'The rule content.', 'type' => 'string', 'example' => '(http.host eq \\"video.example.com\\")'."\n", 'title' => ''], + 'RuleName' => ['description' => 'The rule name.', 'type' => 'string', 'example' => 'rule_example', 'title' => ''], + 'ConfigType' => ['description' => 'The configuration type. Valid values:'."\n" + .'- global: global configuration.'."\n" + .'- rule: rule configuration.', 'type' => 'string', 'example' => 'global', 'title' => ''], + 'VideoSeekEnable' => ['description' => 'The audio seeking switch. Valid values:'."\n" + ."\n" + .'- on: enabled.'."\n" + ."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'FlvVideoSeekMode' => ['description' => 'The FLV seeking mode. Valid values:'."\n" + .'- by_byte: seek by byte.'."\n" + .'- by_time: seek by time.', 'type' => 'string', 'example' => 'by_byte', 'title' => ''], + 'Mp4SeekStart' => ['description' => 'The custom MP4 start parameter.', 'type' => 'string', 'example' => 'start', 'title' => ''], + 'Mp4SeekEnd' => ['description' => 'The custom MP4 end parameter.', 'type' => 'string', 'example' => 'end', 'title' => ''], + 'FlvSeekStart' => ['description' => 'The custom FLV start parameter.', 'type' => 'string', 'example' => 'start', 'title' => ''], + 'FlvSeekEnd' => ['description' => 'The custom FLV end parameter.', 'type' => 'string', 'example' => 'end', 'title' => ''], ], 'title' => '', 'example' => '', @@ -71628,34 +40099,10 @@ 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '55', - 'title' => '', - ], - 'TotalPage' => [ - 'description' => 'The total number of pages returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'title' => '', - ], + 'PageNumber' => ['description' => 'The current page number, which is the same as the PageNumber request parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '55', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], ], 'example' => '', ], @@ -71663,52 +40110,36 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], ], ], '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"}]', - 'title' => 'ListVideoProcessings', + 'title' => 'Query video processing configurations for a site', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListVideoProcessings'], + ], ], 'ramActions' => [ [ - 'operationType' => 'none', + 'operationType' => 'list', 'ramAction' => [ 'action' => 'esa:ListVideoProcessings', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], ], 'ListWafManagedRules' => [ - 'summary' => 'List WAF Managed Rules', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Lists all managed rules under Web Application Firewall (WAF) or filters rules based on specific conditions. You can use this operation to query detailed information about WAF managed rules in a paginated manner.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -71721,9 +40152,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '245026', - 'abilityTreeNodes' => [ - 'FEATUREdcdnV3YEJ8', - ], + 'abilityTreeNodes' => ['FEATUREdcdnV3YEJ8'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -71731,99 +40160,68 @@ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'title' => '站点ID', - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The site ID. You can obtain the site ID by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The WAF instance ID.', 'type' => 'string', 'required' => false, 'example' => 'esa-site-awmmx25y2igw', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'ID of the WAF rule.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10000001', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the WAF rule.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000001', 'title' => ''], ], [ 'name' => 'ManagedRuleset', 'in' => 'query', 'style' => 'json', 'schema' => [ + 'description' => 'The managed ruleset configuration in JSON string format.'."\n" + ."\n" + .'Contains the AttackType, ProtectionLevel, Action, and ManagedRules subfields. When ProtectionLevel is set to -1 (custom mode), specify the status and action for each rule through the ManagedRules array.', 'type' => 'object', 'properties' => [ - 'AttackType' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'ProtectionLevel' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'Action' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'AttackType' => ['description' => 'The attack type encoding. The value cannot be 0.'."\n" + ."\n" + .'Example values: 11 (SQL injection), 12 (XSS), 13 (code execute), 14 (CRLF), 15 (local file inclusion (LFI)), 16 (remote file inclusion (RFI)), 17 (WebShell), 22 (command injection), 26 (SSRF), 27 (path traversal), 28 (protocol violation), 31 (scanner behavior).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '11', 'title' => ''], + 'ProtectionLevel' => ['description' => 'The protection level within the ruleset.'."\n" + ."\n" + .'Valid values: -1 (custom mode, specify each rule through ManagedRules), 1 (loose), 2 (medium), 3 (strict), 4 (super strict).'."\n" + ."\n" + .'When the value is -1, ManagedRules cannot be empty. When the value is greater than 0, Action cannot be empty.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '-1', 'title' => ''], + 'Action' => ['description' => 'The unified action when ProtectionLevel is greater than 0. This parameter cannot be empty in this case.'."\n" + ."\n" + .'Common valid values: monitor, deny, js, captcha. The actual available values depend on the instance quota.', 'type' => 'string', 'required' => false, 'example' => 'monitor', 'title' => ''], 'ManagedRules' => [ + 'description' => 'The rule configuration list in custom mode. This parameter is used only when ProtectionLevel is set to -1.'."\n" + ."\n" + .'Each element contains Id, Status, and Action, which are used to specify the enabled status and action for each managed rule.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'Status' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'Action' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'Id' => ['description' => 'The unique ID of a single managed rule.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20611349', 'title' => ''], + 'Status' => ['description' => 'The rule enabled status.'."\n" + ."\n" + .'Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], + 'Action' => ['description' => 'The action for a single rule. This parameter takes effect only in custom mode (ProtectionLevel = -1).'."\n" + ."\n" + .'Common valid values: monitor, deny, js, captcha. The actual available values depend on the instance quota.', 'type' => 'string', 'required' => false, 'example' => 'js', 'title' => ''], ], + 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], - 'description' => '', + 'required' => false, 'title' => '', 'example' => '', ], ], - 'description' => '', + 'required' => false, 'title' => '', 'example' => '', ], @@ -71831,189 +40229,96 @@ [ 'name' => 'AttackType', 'in' => 'query', - 'schema' => [ - 'description' => 'Attack type of the vulnerability protection event. Values:'."\n" - .'- SQL injection'."\n" - .'- Cross-site scripting'."\n" - .'- Code execution'."\n" - .'- CRLF'."\n" - .'- Local file inclusion'."\n" - .'- Remote file inclusion'."\n" - .'- Webshell'."\n" - .'- Cross-site request forgery'."\n" - .'- Other'."\n" - .'- SEMA', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '11', - 'title' => '', - ], + 'schema' => ['description' => 'The attack type of the vulnerability prevention event. Valid values:'."\n" + .'- SQL injection'."\n" + .'- cross-site scripting (XSS)'."\n" + .'- code execute'."\n" + .'- CRLF'."\n" + .'- local file inclusion (LFI)'."\n" + .'- remote file inclusion (RFI)'."\n" + .'- webshell'."\n" + .'- cross-site request forgery'."\n" + .'- Others'."\n" + .'- SEMA', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '11', 'title' => ''], ], [ 'name' => 'ProtectionLevel', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The currently saved protection level, which represents the existing configuration state in the database.'."\n" + ."\n" + .'Valid values: -1 (custom mode), 1 (loose), 2 (medium), 3 (strict), 4 (super strict).'."\n" + ."\n" + .'Difference from ManagedRuleset.ProtectionLevel: this parameter indicates the currently effective configuration, while ManagedRuleset.ProtectionLevel indicates the target value being passed in.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'Language', 'in' => 'query', - 'schema' => [ - 'description' => 'Language type, which will be used to return the response. Value range:'."\n" - ."\n" - .'- **en**: English.'."\n" - .'- **zh**: Chinese.', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - 'title' => '', - ], + 'schema' => ['description' => 'The language type. The response is returned in the specified language. Valid values:'."\n" + ."\n" + .'- **en**: English.'."\n" + .'- **zh**: Chinese.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'QueryArgs', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '查询条件', - 'description' => 'Query conditions.', + 'title' => '', + 'description' => 'The query conditions.', 'type' => 'object', 'properties' => [ - 'IdNameLike' => [ - 'title' => '模糊查询规则id或规则名称', - 'description' => 'Fuzzy search for rule ID or rule name.', - 'type' => 'string', - 'required' => false, - 'example' => 'example', - ], + 'IdNameLike' => ['title' => '', 'description' => 'Fuzzy match by rule ID or rule name.', 'type' => 'string', 'example' => 'example', 'required' => false], 'ProtectionLevels' => [ - 'description' => 'List of rule protection levels.', + 'description' => 'The list of rule protection levels.', 'type' => 'array', - 'items' => [ - 'description' => 'Rule protection level. Values:'."\n" - .'- Lenient'."\n" - .'- Moderate'."\n" - .'- Strict'."\n" - .'- Ultra strict', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'items' => ['description' => 'The rule protection level. Valid values:'."\n" + .'- Loose'."\n" + .'- Medium'."\n" + .'- Strict'."\n" + .'- Super strict', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], - 'Action' => [ - 'description' => 'Action.', - 'type' => 'string', - 'required' => false, - 'example' => 'deny', - 'title' => '', - ], - 'Status' => [ - 'description' => 'Status.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'Action' => ['description' => 'The action.', 'type' => 'string', 'required' => false, 'example' => 'deny', 'title' => ''], + 'Status' => ['description' => 'The status.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], 'required' => false, - 'example' => '', + 'example' => '{\\"Status\\":\\"\\",\\"ProtectionLevels\\":[2,1],\\"Action\\":\\"\\",\\"IdNameLike\\":\\"\\"}', ], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '查询页号', - 'description' => 'Query page number.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '查询页大小', - 'description' => 'Query page size.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], - 'TotalCount' => [ - 'title' => '过滤后总规则数', - 'description' => 'Total number of rules after filtering.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], + 'TotalCount' => ['title' => '', 'description' => 'The total number of rules after filtering.', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], 'Rules' => [ - 'description' => 'List of managed rules.', + 'description' => 'The list of managed rules.', 'type' => 'array', 'items' => [ - 'description' => 'Details of the managed rule.', + 'description' => 'The managed rule details.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'ID of the managed rule.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100001', - 'title' => '', - ], - 'Name' => [ - 'description' => 'Name of the managed rule.', - 'type' => 'string', - 'example' => 'SQL注入', - 'title' => '', - ], - 'ProtectionLevel' => [ - 'description' => 'Protection level of the managed rule.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'Action' => [ - 'description' => 'Protection action of the managed rule.', - 'type' => 'string', - 'example' => 'deny', - 'title' => '', - ], - 'Status' => [ - 'description' => 'Protection status of the managed rule.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], + 'Id' => ['description' => 'The managed rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100001', 'title' => ''], + 'Name' => ['description' => 'The managed rule name.', 'type' => 'string', 'example' => 'SQL injection ', 'title' => ''], + 'ProtectionLevel' => ['description' => 'The protection level of the managed rule.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Action' => ['description' => 'The protection action of the managed rule.', 'type' => 'string', 'example' => 'deny', 'title' => ''], + 'Status' => ['description' => 'The protection status of the managed rule.', 'type' => 'string', 'example' => 'on', 'title' => ''], ], 'title' => '', 'example' => '', @@ -72021,20 +40326,8 @@ 'title' => '', 'example' => '', ], - 'PageNumber' => [ - 'title' => '页面号码', - 'description' => 'Page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '页面大小', - 'description' => 'Page size.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], + 'PageNumber' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], ], 'example' => '', ], @@ -72042,40 +40335,26 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'title' => 'List WAF Managed Rules', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"TotalCount\\": 20,\\n \\"Rules\\": [\\n {\\n \\"Id\\": 100001,\\n \\"Name\\": \\"SQL injection \\",\\n \\"ProtectionLevel\\": 1,\\n \\"Action\\": \\"deny\\",\\n \\"Status\\": \\"on\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20\\n}","type":"json"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'List WAF managed rules', 'changeSet' => [ - [ - 'createdAt' => '2024-11-12T07:30:12.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2024-11-12T07:30:12.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListWafManagedRules', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWafManagedRules'], ], ], 'ramActions' => [ @@ -72086,27 +40365,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => 'List WAF Phases', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -72119,39 +40387,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239652', - 'abilityTreeNodes' => [ - 'FEATUREdcdnV3YEJ8', - 'FEATUREdcdnUTRW1O', - 'FEATUREdcdnSU2QP6', - 'FEATUREdcdnV3G3FZ', - 'FEATUREdcdnBQ0J3E', - 'FEATUREdcdn1OLUH8', - ], + 'abilityTreeNodes' => ['FEATUREdcdnV3YEJ8', 'FEATUREdcdnUTRW1O', 'FEATUREdcdnSU2QP6', 'FEATUREdcdnV3G3FZ', 'FEATUREdcdnBQ0J3E', 'FEATUREdcdn1OLUH8'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'title' => '站点ID', - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '站点ID', 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'title' => '站点版本', - 'description' => 'Site version.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['title' => '站点版本', 'description' => 'Site version.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], ], 'responses' => [ @@ -72161,12 +40408,7 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], 'Phases' => [ 'title' => '规则集信息列表', 'description' => 'List of WAF operation phases.', @@ -72176,12 +40418,7 @@ 'description' => 'Details of WAF operation phase.', 'type' => 'object', 'properties' => [ - 'Phase' => [ - 'description' => 'Name of the WAF operation phase.', - 'type' => 'string', - 'example' => 'http_custom', - 'title' => '', - ], + 'Phase' => ['description' => 'Name of the WAF operation phase.', 'type' => 'string', 'example' => 'http_custom', 'title' => ''], 'Rulesets' => [ 'description' => 'List of WAF rulesets.', 'type' => 'array', @@ -72189,34 +40426,13 @@ 'description' => 'Details of the WAF ruleset.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'ID of the WAF ruleset.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000001', - 'title' => '', - ], - 'Name' => [ - 'description' => 'Name of the WAF ruleset.', - 'type' => 'string', - 'example' => 'example', - 'title' => '', - ], - 'Shared' => [ - 'description' => 'Shared configuration for rules in the WAF ruleset.', - '$ref' => '#/components/schemas/WafBatchRuleShared', - 'title' => '', - 'example' => '', - ], + 'Id' => ['description' => 'ID of the WAF ruleset.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000001', 'title' => ''], + 'Name' => ['description' => 'Name of the WAF ruleset.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'Shared' => ['description' => 'Shared configuration for rules in the WAF ruleset.', '$ref' => '#/components/schemas/WafBatchRuleShared', 'title' => '', 'example' => ''], 'Rules' => [ 'description' => 'List of rule configurations in the WAF ruleset.', 'type' => 'array', - 'items' => [ - 'description' => 'Rule configuration in the WAF rule set.', - '$ref' => '#/components/schemas/WafRuleConfig', - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'Rule configuration in the WAF rule set.', '$ref' => '#/components/schemas/WafRuleConfig', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], @@ -72239,44 +40455,23 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'List WAF Operation Phases', 'changeSet' => [ - [ - 'createdAt' => '2024-09-25T07:02:50.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T06:13:36.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-25T07:02:50.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T06:13:36.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListWafPhases', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWafPhases'], ], ], 'ramActions' => [ @@ -72287,12 +40482,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -72300,14 +40490,9 @@ '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 1.1.1.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' => 'List WAF Rules', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Lists all rules or filters rules by specific conditions under Web Application Firewall (WAF). You can use this operation to query detailed information about WAF rules in a paged manner.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -72320,125 +40505,53 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239600', - 'abilityTreeNodes' => [ - 'FEATUREdcdnV3YEJ8', - 'FEATUREdcdnUTRW1O', - 'FEATUREdcdnSU2QP6', - 'FEATUREdcdnV3G3FZ', - 'FEATUREdcdnBQ0J3E', - 'FEATUREdcdn1OLUH8', - ], + 'abilityTreeNodes' => ['FEATUREdcdnV3YEJ8', 'FEATUREdcdnUTRW1O', 'FEATUREdcdnSU2QP6', 'FEATUREdcdnV3G3FZ', 'FEATUREdcdnBQ0J3E', 'FEATUREdcdn1OLUH8'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'title' => '站点ID', - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Site version.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'Phase', 'in' => 'query', - 'schema' => [ - 'title' => 'WAF阶段', - 'description' => 'WAF rule type. Values:'."\n" - ."\n" - .'- http_anti_scan: Scan protection'."\n" - .'- http_bot: Bots', - 'type' => 'string', - 'required' => true, - 'example' => 'http_custom', - ], + 'schema' => ['title' => '', 'description' => 'The WAF rule execution phase. Valid values:'."\n" + .'- http_whitelist: whitelist rule'."\n" + .'- http_custom: custom rule'."\n" + .'- http_managed: managed rule'."\n" + .'- http_anti_scan: scan protection rule'."\n" + .'- http_ratelimit: frequency control rule'."\n" + .'- ip_access_rule: IP access rule'."\n" + .'- http_bot: advanced mode bots'."\n" + .'- http_security_level_rule: security rule', 'type' => 'string', 'required' => true, 'example' => 'http_custom'], ], [ 'name' => 'RulesetId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'description' => 'The rule set ID.', - 'example' => '10000001', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the WAF ruleset. You can call the [ListWafRulesets](~~2878359~~) operation to obtain the ruleset ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000001', 'title' => ''], ], [ 'name' => 'QueryArgs', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '查询条件', - 'description' => 'Query filter conditions.', + 'title' => '', + 'description' => 'The query filter conditions.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '精确查询WAF规则ID', - 'description' => 'Exact query for WAF rule ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20000001', - ], - 'NameLike' => [ - 'title' => '模糊查询WAF规则名称', - 'description' => 'Fuzzy query for WAF rule name.', - 'type' => 'string', - 'required' => false, - 'example' => 'example', - ], - 'IdNameLike' => [ - 'title' => '模糊查询规则id或规则名称', - 'description' => 'Fuzzy query for WAF rule ID or name.', - 'type' => 'string', - 'required' => false, - 'example' => 'example', - ], - 'Status' => [ - 'title' => '精确查询WAF规则状态', - 'description' => 'Exact query for WAF rule status.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - ], - 'ConfigValueLike' => [ - 'description' => 'Fuzzy search for values in IP access control.', - 'type' => 'string', - 'required' => false, - 'example' => '10.0.0.1', - 'title' => '', - ], - 'OrderBy' => [ - 'title' => '根据指定的列对返回列表排序', - 'description' => 'Sort the returned list by the specified column.', - 'type' => 'string', - 'required' => false, - 'example' => 'position', - ], - 'Desc' => [ - 'title' => '是否对排序结果取反', - 'description' => 'Whether to reverse the sorting result.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'Id' => ['title' => '', 'description' => 'The WAF rule ID for exact match.', 'type' => 'integer', 'format' => 'int64', 'example' => '20000001', 'required' => false], + 'NameLike' => ['title' => '', 'description' => 'The WAF rule name for fuzzy match.', 'type' => 'string', 'example' => 'example', 'required' => false], + 'IdNameLike' => ['title' => '', 'description' => 'The WAF rule ID or name for fuzzy match.', 'type' => 'string', 'example' => 'example', 'required' => false], + 'Status' => ['title' => '', 'description' => 'The WAF rule status for exact match.', 'type' => 'string', 'example' => 'on', 'required' => false], + 'ConfigValueLike' => ['description' => 'The value in IP access control for fuzzy match.', 'type' => 'string', 'required' => false, 'example' => '10.0.0.1', 'title' => ''], + 'OrderBy' => ['title' => '', 'description' => 'Sorts the returned list by a specified column.', 'type' => 'string', 'example' => 'position', 'required' => false], + 'Desc' => ['title' => '', 'description' => 'Specifies whether to reverse the sort order.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], 'required' => false, 'example' => 'http_custom', @@ -72447,201 +40560,90 @@ [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '查询页号', - 'description' => 'Query page number, used for pagination.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number for pagination.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '查询页大小', - 'description' => 'Query page size, used for pagination.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The page size for pagination.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], - 'SiteUsage' => [ - 'title' => '站点使用量。', - 'description' => 'Site usage.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'InstanceUsage' => [ - 'title' => '站点对应实例中该WAF阶段已使用规则数量', - 'description' => 'Number of rules used in this WAF phase for the corresponding instance of the site.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => '过滤后总规则数', - 'description' => 'Total number of rules after filtering.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], + 'SiteUsage' => ['title' => '', 'description' => 'The site usage.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'InstanceUsage' => ['title' => '', 'description' => 'The number of rules used in the WAF phase for the instance associated with the site.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'TotalCount' => ['title' => '', 'description' => 'The total number of rules after filtering.', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], 'Rules' => [ - 'title' => '返回规则列表', - 'description' => 'Returned list of rules.', + 'title' => '', + 'description' => 'The list of rules returned.', 'type' => 'array', 'items' => [ - 'title' => 'WafPageItemType', - 'description' => 'Rule details.', + 'title' => '', + 'description' => 'The rule details.', 'type' => 'object', 'properties' => [ - 'UpdateTime' => [ - 'title' => '修改时间', - 'description' => 'Modification time.', - 'type' => 'string', - 'example' => '2024-01-01T00:00:00Z', - ], - 'RulesetId' => [ - 'title' => '规则集ID', - 'description' => 'Ruleset ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000001', - ], - 'Id' => [ - 'title' => '规则ID', - 'description' => 'Rule ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20000001', - ], - 'Position' => [ - 'title' => '规则在对应规则集中所处的位置顺序', - 'description' => 'Position order of the rule in the corresponding ruleset.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Phase' => [ - 'title' => 'WAF阶段', - 'description' => 'WAF phase.', - 'type' => 'string', - 'example' => 'http_custom', - ], - 'Type' => [ - 'title' => '规则类型', - 'description' => 'Rule type.', - 'type' => 'string', - 'example' => 'http_custom', - ], - 'Name' => [ - 'title' => '规则名称', - 'description' => 'Rule name.', - 'type' => 'string', - 'example' => 'example', - ], - 'Status' => [ - 'title' => '规则状态', - 'description' => 'Rule status.', - 'type' => 'string', - 'example' => 'on', - ], + 'UpdateTime' => ['title' => '', 'description' => 'The last modification time of the rule.'."\n" + ."\n" + .'Format: RFC 3339 / ISO 8601, UTC time zone (ending with Z).'."\n" + ."\n" + .'Example: 2026-06-10T14:23:45Z', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], + 'RulesetId' => ['title' => '', 'description' => 'The ruleset ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000001'], + 'Id' => ['title' => '', 'description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '20000001'], + 'Position' => ['title' => '', 'description' => 'The position of the rule in the corresponding ruleset.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Phase' => ['title' => '', 'description' => 'The WAF rule execution phase. Valid values:'."\n" + .'- http_whitelist: whitelist rule'."\n" + .'- http_custom: custom rule'."\n" + .'- http_managed: managed rule'."\n" + .'- http_anti_scan: scan protection rule'."\n" + .'- http_ratelimit: frequency control rule'."\n" + .'- ip_access_rule: IP access rule'."\n" + .'- http_bot: advanced mode bots'."\n" + .'- http_security_level_rule: security rule', 'type' => 'string', 'example' => 'http_custom'], + 'Type' => ['title' => '', 'description' => 'The rule type.', 'type' => 'string', 'example' => 'http_custom'], + 'Name' => ['title' => '', 'description' => 'The rule name.', 'type' => 'string', 'example' => 'example'], + 'Status' => ['title' => '', 'description' => 'The rule status.', 'type' => 'string', 'example' => 'on'], 'Fields' => [ - 'title' => '规则的匹配字段列表', - 'description' => 'List of fields for rule matching', + 'title' => '', + 'description' => 'The list of matching fields for the rule.', 'type' => 'array', - 'items' => [ - 'title' => '规则的匹配字段值', - 'description' => 'The value of the rule\'s matching field.', - 'type' => 'string', - 'example' => 'ip.geoip.asnum', - ], + 'items' => ['title' => '', 'description' => 'The matching field value of the rule.', 'type' => 'string', 'example' => 'ip.geoip.asnum'], 'example' => '', ], 'CharacteristicsFields' => [ - 'title' => '频次控制类规则的统计对象列表', - 'description' => 'List of statistical objects for frequency control rules.', + 'title' => '', + 'description' => 'The list of statistical objects for frequency control rules.', 'type' => 'array', - 'items' => [ - 'title' => '频次控制类规则的统计对象', - 'description' => 'Statistical object for frequency control rules.', - 'type' => 'string', - 'example' => 'ip.src', - ], + 'items' => ['title' => '', 'description' => 'The statistical object for frequency control rules.', 'type' => 'string', 'example' => 'ip.src'], 'example' => '', ], - 'Action' => [ - 'title' => '规则对应的动作', - 'description' => 'The action corresponding to the rule.', - 'type' => 'string', - 'example' => 'deny', - ], - 'Skip' => [ - 'title' => '白名单类规则的跳过属性', - 'description' => 'Skip attribute for whitelist rules.', - 'type' => 'string', - 'example' => 'part', - ], + 'Action' => ['title' => '', 'description' => 'The action associated with the rule. Valid values:'."\n" + .'- deny: Block.'."\n" + .'- monitor: Monitor.'."\n" + .'- js: JavaScript Challenge.'."\n" + .'- captcha: Slider challenge.', 'type' => 'string', 'example' => 'deny'], + 'Skip' => ['title' => '', 'description' => 'The skip property for whitelist rules.', 'type' => 'string', 'example' => 'part'], 'Tags' => [ - 'title' => '白名单类规则的跳过WAF阶段列表', - 'description' => 'List of WAF phases to be skipped by whitelist rules.', + 'title' => '', + 'description' => 'The list of WAF phases to skip for whitelist rules.', 'type' => 'array', - 'items' => [ - 'title' => '白名单类规则的跳过WAF阶段值', - 'description' => 'WAF phase value to be skipped by whitelist rules.', - 'type' => 'string', - 'example' => 'http_custom', - ], - 'example' => '', - ], - 'Timer' => [ - 'title' => '规则生效时间配置', - 'description' => 'Configuration for the effective time of the rule.', - '$ref' => '#/components/schemas/WafTimer', - 'example' => '', - ], - 'Config' => [ - 'title' => '规则配置', - 'description' => 'Rule configuration.', - '$ref' => '#/components/schemas/WafRuleConfig', + 'items' => ['title' => '', 'description' => 'The WAF phase value to skip for whitelist rules.', 'type' => 'string', 'example' => 'http_custom'], 'example' => '', ], + 'Timer' => ['title' => '', 'description' => 'The effective period configuration of the rule.', '$ref' => '#/components/schemas/WafTimer', 'example' => ''], + 'Config' => ['title' => '', 'description' => 'The rule configuration.', '$ref' => '#/components/schemas/WafRuleConfig', 'example' => ''], ], 'example' => '', ], 'example' => '', ], - 'PageNumber' => [ - 'title' => '页面号码', - 'description' => 'Page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '页面大小', - 'description' => 'Page size.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], + 'PageNumber' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], ], 'example' => '', ], @@ -72649,37 +40651,19 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'title' => 'List WAF Rules', + '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 1.1.1.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"}]', + 'title' => 'List WAF rules', 'changeSet' => [ - [ - 'createdAt' => '2024-12-12T06:17:42.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-09-25T07:02:50.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-12-12T06:17:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-25T07:02:50.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListWafRules', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWafRules'], ], ], 'ramActions' => [ @@ -72690,27 +40674,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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 1.1.1.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' => 'List WAF Rule Sets', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Lists the rulesets under the current WAF execution phase. Queries basic information and status of rulesets with paging support.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -72723,86 +40696,45 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239588', - 'abilityTreeNodes' => [ - 'FEATUREdcdnBQ0J3E', - 'FEATUREdcdn1OLUH8', - ], + 'abilityTreeNodes' => ['FEATUREdcdnBQ0J3E', 'FEATUREdcdn1OLUH8'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'title' => '站点ID', - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - 'docRequired' => true, - ], + 'schema' => ['title' => '', 'description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'example' => '1', 'required' => true], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Site version.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'Phase', 'in' => 'query', - 'schema' => [ - 'title' => 'WAF阶段', - 'description' => 'WAF operation phase, specifying the rule set phase to query.', - 'type' => 'string', - 'required' => true, - 'example' => 'http_bot', - 'docRequired' => true, - ], + 'schema' => ['title' => '', 'description' => 'The WAF rule execution phase. Valid values:'."\n" + .'- http_whitelist: whitelist rules'."\n" + .'- http_custom: custom rules'."\n" + .'- http_managed: managed rules'."\n" + .'- http_anti_scan: scan protection rules'."\n" + .'- http_ratelimit: frequency control rules'."\n" + .'- ip_access_rule: IP access rules'."\n" + .'- http_bot: advanced mode bots'."\n" + .'- http_security_level_rule: security rules', 'type' => 'string', 'docRequired' => true, 'example' => 'http_bot', 'required' => true], ], [ 'name' => 'QueryArgs', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '查询参数', - 'description' => 'Query parameters, passed in JSON format, containing various filtering conditions.', + 'title' => '', + 'description' => 'The query parameters, passed in JSON format, including various filter conditions.', 'type' => 'object', 'properties' => [ - 'NameLike' => [ - 'title' => '模糊查询规则集名称', - 'description' => 'Fuzzy search for rule set name.', - 'type' => 'string', - 'required' => false, - 'example' => 'example', - ], - 'AnyLike' => [ - 'title' => '模糊搜索规则集ID、规则集名称、规则ID、规则名称。', - 'description' => 'Fuzzy search for rule set ID, rule set name, rule ID, and rule name.', - 'type' => 'string', - 'required' => false, - 'example' => 'example', - ], - 'OrderBy' => [ - 'title' => '指定排序列', - 'description' => 'Specify the column to sort by.', - 'type' => 'string', - 'required' => false, - 'example' => 'id', - ], - 'Desc' => [ - 'title' => '是否倒序排列', - 'description' => 'Whether to sort in descending order.', - 'type' => 'boolean', - 'required' => false, - 'example' => '', - ], + 'NameLike' => ['title' => '', 'description' => 'The fuzzy match string for the ruleset name.', 'type' => 'string', 'example' => 'example', 'required' => false], + 'AnyLike' => ['title' => '', 'description' => 'The fuzzy match string for the ruleset ID, ruleset name, rule ID, or rule name.', 'type' => 'string', 'example' => 'example', 'required' => false], + 'OrderBy' => ['title' => '', 'description' => 'The column by which to sort the results.', 'type' => 'string', 'example' => 'id', 'required' => false], + 'Desc' => ['title' => '', 'description' => 'Specifies whether to sort the results in descending order.', 'type' => 'boolean', 'required' => false, 'example' => ''], ], 'required' => false, 'example' => 'http_bot', @@ -72811,130 +40743,64 @@ [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '页面号码', - 'description' => 'Page number, specifying the current page number for paginated queries.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The page number. Specifies the current page number for paging queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '页面大小', - 'description' => 'Page size, specifying the number of records per page for paginated queries.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The page size. Specifies the number of records per page for paging queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], - 'SiteUsage' => [ - 'description' => 'Number of WAF rule sets used by the site in this WAF operation phase.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - 'title' => '', - ], - 'InstanceUsage' => [ - 'title' => '实例使用量', - 'description' => 'Number of WAF rule sets used by the instance in this WAF operation phase.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'TotalCount' => [ - 'title' => '过滤后总记录数', - 'description' => 'Total number of filtered records.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], + 'SiteUsage' => ['description' => 'The number of WAF rulesets used by the site in this WAF execution phase.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'InstanceUsage' => ['title' => '', 'description' => 'The number of WAF rulesets used by the instance in this WAF execution phase.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'TotalCount' => ['title' => '', 'description' => 'The total number of records after filtering.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], 'Rulesets' => [ - 'title' => '规则集信息列表', - 'description' => 'List of rule set information, containing detailed information about the rule sets.', + 'title' => '', + 'description' => 'The list of rulesets, including detailed information about each ruleset.', 'type' => 'array', 'items' => [ - 'title' => '规则集信息', - 'description' => 'Rule set information', + 'title' => '', + 'description' => 'The ruleset information.', 'type' => 'object', 'properties' => [ - 'UpdateTime' => [ - 'title' => '修改时间', - 'description' => 'Last modification time of the rule set.', - 'type' => 'string', - 'example' => '2024-01-01T00:00:00Z', - ], - 'Id' => [ - 'title' => '规则集ID', - 'description' => 'ID of the WAF rule set.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000001', - ], - 'Name' => [ - 'title' => '规则集名称', - 'description' => 'Name of the rule set.', - 'type' => 'string', - 'example' => 'example', - ], - 'Status' => [ - 'title' => '规则集状态', - 'description' => 'Status of the rule set.', - 'type' => 'string', - 'example' => 'on', - ], - 'Phase' => [ - 'title' => 'WAF阶段', - 'description' => 'WAF operation phase.', - 'type' => 'string', - 'example' => 'http_bot', - ], + 'UpdateTime' => ['title' => '', 'description' => 'The last modification time of the ruleset.'."\n" + ."\n" + .'Format: RFC 3339 / ISO 8601, UTC time zone (ending with Z).'."\n" + ."\n" + .'Example: 2026-06-10T14:23:45Z', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], + 'Id' => ['title' => '', 'description' => 'The ID of the WAF ruleset. You can call the [ListWafRulesets](~~2878359~~) operation to obtain the ruleset ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000001'], + 'Name' => ['title' => '', 'description' => 'The ruleset name.', 'type' => 'string', 'example' => 'example'], + 'Status' => ['title' => '', 'description' => 'The ruleset status.', 'type' => 'string', 'example' => 'on'], + 'Phase' => ['title' => '', 'description' => 'The WAF rule execution phase. Valid values:'."\n" + .'- http_whitelist: whitelist rules'."\n" + .'- http_custom: custom rules'."\n" + .'- http_managed: managed rules'."\n" + .'- http_anti_scan: scan protection rules'."\n" + .'- http_ratelimit: frequency control rules'."\n" + .'- ip_access_rule: IP access rules'."\n" + .'- http_bot: advanced mode bots'."\n" + .'- http_security_level_rule: security rules', 'type' => 'string', 'example' => 'http_bot'], 'Types' => [ - 'title' => '规则类型列表', - 'description' => 'List of rule types.', + 'title' => '', + 'description' => 'The list of rule types.', 'type' => 'array', - 'items' => [ - 'title' => '规则类型', - 'description' => 'Rule type.', - 'type' => 'string', - 'example' => 'http_custom_cc', - ], + 'items' => ['title' => '', 'description' => 'The rule type.', 'type' => 'string', 'example' => 'http_custom_cc'], 'example' => '', ], - 'Target' => [ - 'title' => 'http_bot中防护目标类型', - 'description' => 'Protection target type in http_bot.', - 'type' => 'string', - 'example' => 'web', - ], + 'Target' => ['title' => '', 'description' => 'The protection target type in http_bot.', 'type' => 'string', 'example' => 'web'], 'Fields' => [ - 'title' => '匹配对象列表', - 'description' => 'List of match objects.', + 'title' => '', + 'description' => 'The list of match objects.', 'type' => 'array', - 'items' => [ - 'title' => '匹配对象', - 'description' => 'Match object.', - 'type' => 'string', - 'example' => 'http.request.headers', - ], + 'items' => ['title' => '', 'description' => 'The match object.', 'type' => 'string', 'example' => 'http.request.headers'], 'example' => '', ], ], @@ -72942,20 +40808,8 @@ ], 'example' => '', ], - 'PageNumber' => [ - 'title' => '页面号码', - 'description' => 'Current page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '页面大小', - 'description' => 'Page size.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], + 'PageNumber' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], ], 'example' => '', ], @@ -72963,72 +40817,40 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'List WAF Rule Sets', + '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' => 'List WAF rulesets', 'changeSet' => [ - [ - 'createdAt' => '2024-09-25T07:02:50.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T06:13:41.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-25T07:02:50.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T06:13:41.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListWafRulesets', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWafRulesets'], ], ], 'ramActions' => [ [ - 'operationType' => 'list', + 'operationType' => 'get', 'ramAction' => [ 'action' => 'esa:ListWafRulesets', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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\\": 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"}]', - 'translator' => 'machine', ], 'ListWafTemplateRules' => [ - 'summary' => 'List WAF Template Rules', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Lists the template rules in WAF. These rules are typically predefined rulesets for quickly enabling protection against common attack types.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -73041,49 +40863,23 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239638', - 'abilityTreeNodes' => [ - 'FEATUREdcdnV3YEJ8', - 'FEATUREdcdnUTRW1O', - 'FEATUREdcdnSU2QP6', - 'FEATUREdcdnV3G3FZ', - 'FEATUREdcdnBQ0J3E', - 'FEATUREdcdn1OLUH8', - ], + 'abilityTreeNodes' => ['FEATUREdcdnV3YEJ8', 'FEATUREdcdnUTRW1O', 'FEATUREdcdnSU2QP6', 'FEATUREdcdnV3G3FZ', 'FEATUREdcdnBQ0J3E', 'FEATUREdcdn1OLUH8'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. To obtain this ID, call the [ListSites](~~2850189~~) API.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID. ', - 'type' => 'string', - 'required' => false, - 'example' => 'esa-site-aud6ftk57ym8', - 'title' => '', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'esa-site-aud6ftk57ym8', 'title' => ''], ], [ 'name' => 'Phase', 'in' => 'query', - 'schema' => [ - 'title' => 'WAF阶段', - 'description' => 'WAF operation phase, used to filter template rules for a specific phase.', - 'type' => 'string', - 'required' => false, - 'example' => 'http_anti_scan', - ], + 'schema' => ['title' => 'WAF阶段', 'description' => 'The WAF running phase for filtering template rules.', 'type' => 'string', 'example' => 'http_anti_scan', 'required' => false], ], [ 'name' => 'QueryArgs', @@ -73091,25 +40887,16 @@ 'style' => 'json', 'schema' => [ 'title' => '查询参数', - 'description' => 'Query parameters, used to filter template rules based on conditions such as rule type.', + 'description' => 'The query parameters for filtering template rules by criteria such as the rule type.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '规则类型', - 'description' => 'Rule type.', - 'type' => 'string', - 'required' => false, - 'example' => 'http_directory_traversal', - ], + 'Type' => ['title' => '规则类型', 'description' => 'The rule type.', 'type' => 'string', 'example' => 'http_directory_traversal', 'required' => false], 'Kinds' => [ - 'description' => 'List of template kinds. ', + 'description' => 'A list of template kinds.', 'type' => 'array', 'items' => [ - 'enumValueTitles' => [ - 'template' => 'template ', - 'template-featured' => 'template-featured ', - ], - 'description' => 'Template kind. ', + 'description' => 'The template kind.', + 'enumValueTitles' => ['template' => 'template', 'template-featured' => 'template-featured'], 'type' => 'string', 'required' => false, 'example' => 'template', @@ -73129,54 +40916,24 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], 'Rules' => [ 'title' => '规则列表', - 'description' => 'The list of returned template rules.', + 'description' => 'A list of template rules.', 'type' => 'array', 'items' => [ 'title' => '规则信息', - 'description' => 'Rule information.', + 'description' => 'The details of a template rule.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '规则名称', - 'description' => 'Rule name.', - 'type' => 'string', - 'example' => 'HTTP Directory Traversal Rule [Template]', - ], - 'Status' => [ - 'title' => '规则状态', - 'description' => 'Rule status.', - 'type' => 'string', - 'example' => 'on', - ], - 'Type' => [ - 'title' => '规则类型', - 'description' => 'Rule type.', - 'type' => 'string', - 'example' => 'http_directory_traversal', - ], - 'Phase' => [ - 'title' => 'WAF阶段', - 'description' => 'WAF operation phase.', - 'type' => 'string', - 'example' => 'http_anti_scan', - ], - 'Config' => [ - 'title' => '规则配置', - 'description' => 'Rule configuration.', - '$ref' => '#/components/schemas/WafRuleConfig', - 'example' => '', - ], + 'Name' => ['title' => '规则名称', 'description' => 'The rule name.', 'type' => 'string', 'example' => 'HTTP Directory Traversal Rule [Template]'], + 'Status' => ['title' => '规则状态', 'description' => 'The rule status.', 'type' => 'string', 'example' => 'on'], + 'Type' => ['title' => '规则类型', 'description' => 'The rule type.', 'type' => 'string', 'example' => 'http_directory_traversal'], + 'Phase' => ['title' => 'WAF阶段', 'description' => 'The WAF running phase.', 'type' => 'string', 'example' => 'http_anti_scan'], + 'Config' => ['title' => '规则配置', 'description' => 'The rule configuration.', '$ref' => '#/components/schemas/WafRuleConfig', 'example' => ''], ], 'example' => '', ], @@ -73189,52 +40946,25 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'List WAF Template Rules', 'changeSet' => [ - [ - 'createdAt' => '2025-04-11T03:39:54.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-11-12T07:30:11.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-09-25T07:02:50.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T06:13:35.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-04-11T03:39:54.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-12T07:30:11.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-25T07:02:50.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T06:13:35.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListWafTemplateRules', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWafTemplateRules'], ], ], 'ramActions' => [ @@ -73245,12 +40975,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -73258,13 +40983,9 @@ '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 1.1.1.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' => [ - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Lists the usage of WAF rules.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -73277,90 +40998,49 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239653', - 'abilityTreeNodes' => [ - 'FEATUREdcdnV3YEJ8', - 'FEATUREdcdnUTRW1O', - 'FEATUREdcdnSU2QP6', - 'FEATUREdcdnV3G3FZ', - 'FEATUREdcdnBQ0J3E', - 'FEATUREdcdn1OLUH8', - ], + 'abilityTreeNodes' => ['FEATUREdcdnV3YEJ8', 'FEATUREdcdnUTRW1O', 'FEATUREdcdnSU2QP6', 'FEATUREdcdnV3G3FZ', 'FEATUREdcdnBQ0J3E', 'FEATUREdcdn1OLUH8'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The WAF instance ID.'."\n" + ."\n" + .'If this parameter is left empty, the API returns an empty result. We recommend that you always specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'esa-site-b0wdsrlba3nk', 'title' => ''], ], [ 'name' => 'Phase', 'in' => 'query', - 'schema' => [ - 'title' => 'WAF阶段', - 'description' => 'Name of the WAF operation phase.', - 'type' => 'string', - 'required' => false, - 'example' => 'http_custom', - ], + 'schema' => ['title' => '', 'description' => 'The phase in which the WAF rule runs. This parameter is required.'."\n" + ."\n" + .'Common values: http_custom, http_ratelimit, http_anti_scan, http_bot, http_managed, http_whitelist, and http_threat_intelligence.'."\n" + ."\n" + .'> Note: This parameter is required on the server side. If this parameter is not specified, the API returns InvalidParameter (400).', 'type' => 'string', 'example' => 'http_custom', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], 'Sites' => [ - 'description' => 'List of site usage.', + 'description' => 'The list of site usage.', 'type' => 'array', 'items' => [ - 'description' => 'Details of site usage.', + 'description' => 'The site usage details.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'Site ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'title' => '', - ], - 'Name' => [ - 'description' => 'Site name.', - 'type' => 'string', - 'example' => 'example.com', - 'title' => '', - ], - 'Usage' => [ - 'description' => 'Usage of WAF rules/WAF rule sets.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'title' => '', - ], + 'Id' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Name' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'Usage' => ['description' => 'The number of WAF rules or WAF rule sets that have been used.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', @@ -73368,20 +41048,8 @@ 'title' => '', 'example' => '', ], - 'BatchConfigUsage' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'InstanceUsage' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'BatchConfigUsage' => ['description' => 'The number of rules or rule sets for the specified phase under instance-level batch configuration.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'InstanceUsage' => ['description' => 'The total number of rules or rule sets for the instance under the specified phase, including both site-level and instance-level rules.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], ], 'example' => '', ], @@ -73389,45 +41057,24 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'title' => 'List WAF Rule Usage', - 'summary' => 'List WAF Rule Usage', + '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\\": 1,\\n \\"InstanceUsage\\": 2\\n}","type":"json"}]', + 'title' => 'List WAF rule usage', 'changeSet' => [ - [ - 'createdAt' => '2024-09-25T07:02:49.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T06:13:41.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-25T07:02:49.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T06:13:41.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListWafUsageOfRules', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWafUsageOfRules'], ], ], 'ramActions' => [ @@ -73438,26 +41085,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => 'Queries the information about waiting room events for a waiting room.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries waiting room events for a waiting room.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -73470,219 +41107,104 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239610', - 'abilityTreeNodes' => [ - 'FEATUREdcdnVCBH9N', - ], + 'abilityTreeNodes' => ['FEATUREdcdnVCBH9N'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '7096621098****', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7096621098****', 'title' => ''], ], [ 'name' => 'WaitingRoomId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the waiting room, which can be obtained by calling the [ListWaitingRooms](~~2850279~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '6a51d5bc6460887abd129****', - 'title' => '', - ], + 'schema' => ['description' => 'The unique ID of the waiting room, which can be obtained by calling the [ListWaitingRooms](~~2850279~~) operation.', 'type' => 'string', 'required' => true, 'example' => '6a51d5bc6460887abd129****', 'title' => ''], ], [ 'name' => 'WaitingRoomEventId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the waiting room event. This parameter is optional. You can specify this parameter to query a specific waiting room event.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '89677721098****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the waiting room event. This parameter is optional. You can specify this parameter to query a specific waiting room event.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '89677721098****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID, which is used to trace a call.'."\n", - 'type' => 'string', - 'example' => 'f3c3700a-4c0f-4a24-b576-fd7dbf9e7c55', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID, which is used to trace a call.', 'type' => 'string', 'example' => 'f3c3700a-4c0f-4a24-b576-fd7dbf9e7c55'], 'WaitingRoomEvents' => [ - 'description' => 'The details of the waiting room events.'."\n", + 'description' => 'The details of the waiting room events.', 'type' => 'array', 'items' => [ - 'description' => 'The details of the waiting room event.'."\n", + 'description' => 'The details of the waiting room event.', 'type' => 'object', 'properties' => [ - 'WaitingRoomEventId' => [ - 'description' => 'The unique ID of the waiting room event.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '89677721098****'."\n", - 'title' => '', - ], - 'WaitingRoomId' => [ - 'description' => 'The ID of the waiting room associated with the event.'."\n", - 'type' => 'string', - 'example' => '5c938a045c9ca46607163d34966****', - 'title' => '', - ], - 'Enable' => [ - 'description' => 'The event status. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The custom event name.'."\n", - 'type' => 'string', - 'example' => '测试事件', - 'title' => '', - ], - 'TotalActiveUsers' => [ - 'description' => 'The maximum number of active users.'."\n", - 'type' => 'string', - 'example' => '22', - 'title' => '', - ], - 'NewUsersPerMinute' => [ - 'description' => 'The maximum number of new users per minute.'."\n", - 'type' => 'string', - 'example' => '11', - 'title' => '', - ], - 'SessionDuration' => [ - 'description' => 'The maximum duration for which a session remains valid after a user leaves the origin. Unit: minutes.'."\n", - 'type' => 'string', - 'example' => '3', - 'title' => '', - ], - 'DisableSessionRenewalEnable' => [ - 'description' => 'Indicates whether session renewal is disabled. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'off', - 'title' => '', - ], - 'QueuingMethod' => [ - 'description' => 'The queuing method. Valid values:'."\n" - ."\n" - .'* random: Users gain access to the origin randomly, regardless of the arrival time.'."\n" - .'* fifo: Users gain access to the origin in order of arrival.'."\n" - .'* passthrough: Users pass through the waiting room and go straight to the origin.'."\n" - .'* reject-all: Users are blocked from reaching the origin.'."\n", - 'type' => 'string', - 'example' => 'fifo', - 'title' => '', - ], - 'QueuingStatusCode' => [ - 'description' => 'The HTTP status code to return while a user is in the queue. Valid values:'."\n" - ."\n" - .'* 200'."\n" - .'* 202'."\n" - .'* 429'."\n", - 'type' => 'string', - 'example' => '200', - 'title' => '', - ], - 'JsonResponseEnable' => [ - 'description' => 'Indicates whether JOSN response is enabled. If JSON response is enabled, a JSON body is returned for requests to the waiting room with the header Accept: application/json. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'off', - 'title' => '', - ], - 'Description' => [ - 'description' => 'The event description.'."\n", - 'type' => 'string', - 'example' => 'terraform-example', - 'title' => '', - ], - 'WaitingRoomType' => [ - 'description' => 'The type of the waiting room. Valid values:'."\n" - ."\n" - .'* default'."\n" - .'* custom'."\n", - 'type' => 'string', - 'example' => 'custom', - 'title' => '', - ], - 'CustomPageHtml' => [ - 'description' => 'The content of the custom waiting room page. This parameter is returned when the waiting room type is set to custom. The content is URL-encoded.'."\n", - 'type' => 'string', - 'example' => 'html-yets-maqi1111', - 'title' => '', - ], - 'StartTime' => [ - 'description' => 'The start time of the event. This value is a UNIX timestamp.'."\n", - 'type' => 'string', - 'example' => '1719814398', - 'title' => '', - ], - 'EndTime' => [ - 'description' => 'The end time of the event. This value is a UNIX timestamp.'."\n", - 'type' => 'string', - 'example' => '1719814497', - 'title' => '', - ], - 'PreQueueEnable' => [ - 'description' => 'Indicates whether pre-queuing is enabled. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'PreQueueStartTime' => [ - 'description' => 'The start time for pre-queuing. This value is a UNIX timestamp. This parameter is valid only when pre-queuing is enabled.'."\n", - 'type' => 'string', - 'example' => '1719814097', - 'title' => '', - ], - 'RandomPreQueueEnable' => [ - 'description' => 'Indicates whether random queuing is enabled. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Language' => [ - 'description' => 'The language of the waiting room page. This parameter is returned when the waiting room type is set to default. Valid values:'."\n" - ."\n" - .'* enus: English.'."\n" - .'* zhcn: Simplified Chinese.'."\n" - .'* zhhk: Traditional Chinese.'."\n", - 'type' => 'string', - 'example' => 'zhcn', - 'title' => '', - ], + 'WaitingRoomEventId' => ['description' => 'The unique ID of the waiting room event.', 'type' => 'integer', 'format' => 'int64', 'example' => '89677721098****'."\n", 'title' => ''], + 'WaitingRoomId' => ['description' => 'The ID of the waiting room associated with the event.', 'type' => 'string', 'example' => '5c938a045c9ca46607163d34966****', 'title' => ''], + 'Enable' => ['description' => 'The event status. Valid values:'."\n" + ."\n" + .'- on'."\n" + ."\n" + .'- off', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Name' => ['description' => 'The custom event name.', 'type' => 'string', 'example' => 'Test event', 'title' => ''], + 'TotalActiveUsers' => ['description' => 'The maximum number of active users.', 'type' => 'string', 'example' => '22', 'title' => ''], + 'NewUsersPerMinute' => ['description' => 'The maximum number of new users per minute.', 'type' => 'string', 'example' => '11', 'title' => ''], + 'SessionDuration' => ['description' => 'The maximum duration for which a session remains valid after a user leaves the origin. Unit: minutes.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'DisableSessionRenewalEnable' => ['description' => 'Indicates whether session renewal is disabled. Valid values:'."\n" + ."\n" + .'- on'."\n" + ."\n" + .'- off', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'QueuingMethod' => ['description' => 'The queuing method. Valid values:'."\n" + ."\n" + .'- random: Users gain access to the origin randomly, regardless of the arrival time.'."\n" + ."\n" + .'- fifo: Users gain access to the origin in order of arrival.'."\n" + ."\n" + .'- passthrough: Users pass through the waiting room and go straight to the origin.'."\n" + ."\n" + .'- reject-all: Users are blocked from reaching the origin.', 'type' => 'string', 'example' => 'fifo', 'title' => ''], + 'QueuingStatusCode' => ['description' => 'The HTTP status code to return while a user is in the queue. Valid values:'."\n" + ."\n" + .'- 200'."\n" + ."\n" + .'- 202'."\n" + ."\n" + .'- 429', 'type' => 'string', 'example' => '200', 'title' => ''], + 'JsonResponseEnable' => ['description' => 'Indicates whether JOSN response is enabled. If JSON response is enabled, a JSON body is returned for requests to the waiting room with the header Accept: application/json. Valid values:'."\n" + ."\n" + .'- on'."\n" + ."\n" + .'- off', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'Description' => ['description' => 'The event description.', 'type' => 'string', 'example' => 'terraform-example', 'title' => ''], + 'WaitingRoomType' => ['description' => 'The type of the waiting room. Valid values:'."\n" + ."\n" + .'- default'."\n" + ."\n" + .'- custom', 'type' => 'string', 'example' => 'custom', 'title' => ''], + 'CustomPageHtml' => ['description' => 'The content of the custom waiting room page. This parameter is returned when the waiting room type is set to custom. The content is URL-encoded.', 'type' => 'string', 'example' => 'html-yets-maqi1111', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the event. This value is a UNIX timestamp.', 'type' => 'string', 'example' => '1719814398', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the event. This value is a UNIX timestamp.', 'type' => 'string', 'example' => '1719814497', 'title' => ''], + 'PreQueueEnable' => ['description' => 'Indicates whether pre-queuing is enabled. Valid values:'."\n" + ."\n" + .'- on'."\n" + ."\n" + .'- off', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'PreQueueStartTime' => ['description' => 'The start time for pre-queuing. This value is a UNIX timestamp. This parameter is valid only when pre-queuing is enabled.', 'type' => 'string', 'example' => '1719814097', 'title' => ''], + 'RandomPreQueueEnable' => ['description' => 'Indicates whether random queuing is enabled. Valid values:'."\n" + ."\n" + .'- on'."\n" + ."\n" + .'- off', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Language' => ['description' => 'The language of the waiting room page. This parameter is returned when the waiting room type is set to default. Valid values:'."\n" + ."\n" + .'- enus: English.'."\n" + ."\n" + .'- zhcn: Simplified Chinese.'."\n" + ."\n" + .'- zhhk: Traditional Chinese.', 'type' => 'string', 'example' => 'zhcn', 'title' => ''], ], 'title' => '', 'example' => '', @@ -73698,73 +41220,47 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], 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' => '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.', - ], + ['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' => '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.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - '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"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"f3c3700a-4c0f-4a24-b576-fd7dbf9e7c55\\",\\n \\"WaitingRoomEvents\\": [\\n {\\n \\"WaitingRoomEventId\\": 0,\\n \\"WaitingRoomId\\": \\"5c938a045c9ca46607163d34966****\\",\\n \\"Enable\\": \\"on\\",\\n \\"Name\\": \\"Test event\\",\\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"}]', 'title' => 'ListWaitingRoomEvents', - 'description' => 'You can call this operation to query details of all waiting room events related to a waiting room in a website.'."\n", + 'description' => 'Use this operation to query details of all waiting room events related to a waiting room in a website.', 'changeSet' => [ - [ - 'createdAt' => '2024-09-18T06:13:41.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-18T06:13:41.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListWaitingRoomEvents', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWaitingRoomEvents'], ], ], 'ramActions' => [ [ - 'operationType' => 'list', + 'operationType' => 'none', 'ramAction' => [ 'action' => 'esa:ListWaitingRoomEvents', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], + 'translator' => 'manual', ], 'ListWaitingRoomRules' => [ 'summary' => 'Query Waiting Room Bypass Rules', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -73777,57 +41273,29 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239649', - 'abilityTreeNodes' => [ - 'FEATUREdcdnVCBH9N', - ], + 'abilityTreeNodes' => ['FEATUREdcdnVCBH9N'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'WaitingRoomId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the waiting room to bypass, which can be obtained by calling the [ListWaitingRooms](~~2850279~~) interface.', - 'type' => 'string', - 'required' => true, - 'example' => '6a51d5bc6460887abd129****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the waiting room to bypass, which can be obtained by calling the [ListWaitingRooms](~~2850279~~) interface.', 'type' => 'string', 'required' => true, 'example' => '6a51d5bc6460887abd129****', 'title' => ''], ], [ 'name' => 'WaitingRoomRuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the waiting room bypass rule to update, which can be obtained by calling the [ListWaitingRoomRules](~~2850279~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '37286782688****'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the waiting room bypass rule to update, which can be obtained by calling the [ListWaitingRoomRules](~~2850279~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '37286782688****'."\n", 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name, optional, used for querying by the name of the waiting room bypass rule.', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - 'title' => '', - ], + 'schema' => ['description' => 'Rule name, optional, used for querying by the name of the waiting room bypass rule.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ @@ -73836,12 +41304,7 @@ 'description' => 'Query response result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID, used for tracking the call status.', - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A123425345', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID, used for tracking the call status.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A123425345'], 'WaitingRoomRules' => [ 'description' => 'List of waiting room bypass rules.', 'type' => 'array', @@ -73849,35 +41312,14 @@ 'description' => 'Details of the waiting room bypass rule.', 'type' => 'object', 'properties' => [ - 'WaitingRoomRuleId' => [ - 'description' => 'Rule ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '37286782688****', - 'title' => '', - ], - 'RuleName' => [ - 'description' => 'Rule name. This parameter does not need to be set when adding global configuration.', - 'type' => 'string', - 'example' => 'ip', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Rule switch. This parameter does not need to be set when adding global configuration. Value range:'."\n" - .'- on: enabled.'."\n" - .'- off: disabled.', - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter does not need to be set when adding global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: set the value to true'."\n" - .'- Match specific requests: set the value to a custom expression, e.g., (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'example' => '(http.request.uri.path.file_name eq \\"jpg\\")', - 'title' => '', - ], + 'WaitingRoomRuleId' => ['description' => 'Rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '37286782688****', 'title' => ''], + 'RuleName' => ['description' => 'Rule name. This parameter does not need to be set when adding global configuration.', 'type' => 'string', 'example' => 'ip', 'title' => ''], + 'RuleEnable' => ['description' => 'Rule switch. This parameter does not need to be set when adding global configuration. Value range:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Rule' => ['description' => 'Rule content, using conditional expressions to match user requests. This parameter does not need to be set when adding global configuration. There are two usage scenarios:'."\n" + .'- Match all incoming requests: set the value to true'."\n" + .'- Match specific requests: set the value to a custom expression, e.g., (http.host eq \\"video.example.com\\")', 'type' => 'string', 'example' => '(http.request.uri.path.file_name eq \\"jpg\\")', 'title' => ''], ], 'title' => '', 'example' => '', @@ -73893,40 +41335,22 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], 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' => '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.', - ], + ['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' => '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.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'Query Waiting Room Bypass Rules List', 'description' => 'This API allows users to query the list of waiting room bypass rules associated with a specific site.', 'changeSet' => [ - [ - 'createdAt' => '2024-09-18T06:13:41.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-18T06:13:41.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListWaitingRoomRules', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWaitingRoomRules'], ], ], 'ramActions' => [ @@ -73937,12 +41361,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -73953,13 +41372,9 @@ ], ], 'ListWaitingRooms' => [ - 'summary' => 'Queries the information about all waiting rooms in a website.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries all waiting rooms in a website.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -73972,110 +41387,57 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239611', - 'abilityTreeNodes' => [ - 'FEATUREdcdnO4KC7Z', - ], + 'abilityTreeNodes' => ['FEATUREdcdnO4KC7Z'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '120876698010528', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '120876698010528', 'title' => ''], ], [ 'name' => 'WaitingRoomId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the waiting room. Specify this parameter to query the information about a specific waiting room.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '6a51d5bc6460887abd1291dc7d4d****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the waiting room. Specify this parameter to query the information about a specific waiting room.', 'type' => 'string', 'required' => false, 'example' => '6a51d5bc6460887abd1291dc7d4d****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response.'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID, which is used to trace a call.'."\n", - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID, which is used to trace a call.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'], 'WaitingRooms' => [ - 'description' => 'The waiting rooms.'."\n", + 'description' => 'The waiting rooms.', 'type' => 'array', 'items' => [ - 'description' => 'The details of the waiting room.'."\n", + 'description' => 'The details of the waiting room.', 'type' => 'object', 'properties' => [ - 'WaitingRoomId' => [ - 'description' => 'The unique ID of the waiting room.'."\n", - 'type' => 'string', - 'example' => '6a51d5bc6460887abd1291dc7d4d****'."\n", - 'title' => '', - ], - 'Enable' => [ - 'description' => 'Indicates whether the waiting room is enabled. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Name' => [ - 'description' => 'The name of the waiting room.'."\n", - 'type' => 'string', - 'example' => '测试等候室', - 'title' => '', - ], - 'QueueAllEnable' => [ - 'description' => 'Indicates whether all requests must be queued. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], + 'WaitingRoomId' => ['description' => 'The unique ID of the waiting room.', 'type' => 'string', 'example' => '6a51d5bc6460887abd1291dc7d4d****'."\n", 'title' => ''], + 'Enable' => ['description' => 'Indicates whether the waiting room is enabled. Valid values:'."\n" + ."\n" + .'- on'."\n" + ."\n" + .'- off', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Name' => ['description' => 'The name of the waiting room.', 'type' => 'string', 'example' => 'Test waiting room', 'title' => ''], + 'QueueAllEnable' => ['description' => 'Indicates whether all requests must be queued. Valid values:'."\n" + ."\n" + .'- on'."\n" + ."\n" + .'- off', 'type' => 'string', 'example' => 'on', 'title' => ''], 'HostNameAndPath' => [ - 'description' => 'The hostname and path.'."\n", + 'description' => 'The hostname and path.', 'type' => 'array', 'items' => [ - 'description' => 'The details of the hostname and path.'."\n", + 'description' => 'The details of the hostname and path.', 'type' => 'object', 'properties' => [ - 'Subdomain' => [ - 'description' => 'The subdomain.'."\n", - 'type' => 'string', - 'example' => 'test.'."\n", - 'title' => '', - ], - 'Domain' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'example' => 'example.com'."\n", - 'title' => '', - ], - 'Path' => [ - 'description' => 'The path.'."\n", - 'type' => 'string', - 'example' => '/test', - 'title' => '', - ], + 'Subdomain' => ['description' => 'The subdomain.', 'type' => 'string', 'example' => 'test.'."\n", 'title' => ''], + 'Domain' => ['description' => 'The domain name.', 'type' => 'string', 'example' => 'example.com'."\n", 'title' => ''], + 'Path' => ['description' => 'The path.', 'type' => 'string', 'example' => '/test', 'title' => ''], ], 'title' => '', 'example' => '', @@ -74083,100 +41445,50 @@ 'title' => '', 'example' => '', ], - 'CookieName' => [ - 'description' => 'The name of the custom cookie.'."\n", - 'type' => 'string', - 'example' => '__aliwaitingroom_example', - 'title' => '', - ], - 'TotalActiveUsers' => [ - 'description' => 'The maximum number of active users.'."\n", - 'type' => 'string', - 'example' => '300', - 'title' => '', - ], - 'NewUsersPerMinute' => [ - 'description' => 'The maximum number of new users per minute.'."\n", - 'type' => 'string', - 'example' => '200', - 'title' => '', - ], - 'SessionDuration' => [ - 'description' => 'The maximum duration for which a session remains valid after a user leaves the origin. Unit: minutes.'."\n", - 'type' => 'string', - 'example' => '3600', - 'title' => '', - ], - 'DisableSessionRenewalEnable' => [ - 'description' => 'Indicates whether session renewal is disabled. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'QueuingMethod' => [ - 'description' => 'The queuing method. Valid values:'."\n" - ."\n" - .'* random: Users gain access to the origin randomly, regardless of the arrival time.'."\n" - .'* fifo: Users gain access to the origin in order of arrival.'."\n" - .'* passthrough: Users pass through the waiting room and go straight to the origin.'."\n" - .'* reject-all: Users are blocked from reaching the origin.'."\n", - 'type' => 'string', - 'example' => 'random', - 'title' => '', - ], - 'QueuingStatusCode' => [ - 'description' => 'The HTTP status code to return while a user is in the queue. Valid values:'."\n" - ."\n" - .'* 200'."\n" - .'* 202'."\n" - .'* 429'."\n", - 'type' => 'string', - 'example' => '200', - 'title' => '', - ], - 'JsonResponseEnable' => [ - 'description' => 'Indicates whether JSON response is enabled. If you set this parameter to on, a JSON body is returned for requests to the waiting room with the header Accept: application/json. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'example' => 'on', - 'title' => '', - ], - 'Description' => [ - 'description' => 'The description of the waiting room.'."\n", - 'type' => 'string', - 'example' => '测试等候室', - 'title' => '', - ], - 'WaitingRoomType' => [ - 'description' => 'The type of the waiting room. Valid values:'."\n" - ."\n" - .'* default'."\n" - .'* custom'."\n", - 'type' => 'string', - 'example' => 'default', - 'title' => '', - ], - 'CustomPageHtml' => [ - 'description' => 'The HTML content or identifier of the custom queuing page. This parameter is valid only when `WaitingRoomType` is set to `custom`. The content must be URL-encoded.'."\n", - 'type' => 'string', - 'example' => '自定义HTML内容或标识', - 'title' => '', - ], - 'Language' => [ - 'description' => 'The language of the waiting room page. This parameter is returned when the waiting room type is set to default. Valid values:'."\n" - ."\n" - .'* enus: English.'."\n" - .'* zhcn: Simplified Chinese.'."\n" - .'* zhhk: Traditional Chinese.'."\n", - 'type' => 'string', - 'example' => 'zhcn', - 'title' => '', - ], + 'CookieName' => ['description' => 'The name of the custom cookie.', 'type' => 'string', 'example' => '__aliwaitingroom_example', 'title' => ''], + 'TotalActiveUsers' => ['description' => 'The maximum number of active users.', 'type' => 'string', 'example' => '300', 'title' => ''], + 'NewUsersPerMinute' => ['description' => 'The maximum number of new users per minute.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'SessionDuration' => ['description' => 'The maximum duration for which a session remains valid after a user leaves the origin. Unit: minutes.', 'type' => 'string', 'example' => '3600', 'title' => ''], + 'DisableSessionRenewalEnable' => ['description' => 'Indicates whether session renewal is disabled. Valid values:'."\n" + ."\n" + .'- on'."\n" + ."\n" + .'- off', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'QueuingMethod' => ['description' => 'The queuing method. Valid values:'."\n" + ."\n" + .'- random: Users gain access to the origin randomly, regardless of the arrival time.'."\n" + ."\n" + .'- fifo: Users gain access to the origin in order of arrival.'."\n" + ."\n" + .'- passthrough: Users pass through the waiting room and go straight to the origin.'."\n" + ."\n" + .'- reject-all: Users are blocked from reaching the origin.', 'type' => 'string', 'example' => 'random', 'title' => ''], + 'QueuingStatusCode' => ['description' => 'The HTTP status code to return while a user is in the queue. Valid values:'."\n" + ."\n" + .'- 200'."\n" + ."\n" + .'- 202'."\n" + ."\n" + .'- 429', 'type' => 'string', 'example' => '200', 'title' => ''], + 'JsonResponseEnable' => ['description' => 'Indicates whether JSON response is enabled. If you set this parameter to on, a JSON body is returned for requests to the waiting room with the header Accept: application/json. Valid values:'."\n" + ."\n" + .'- on'."\n" + ."\n" + .'- off', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Description' => ['description' => 'The description of the waiting room.', 'type' => 'string', 'example' => 'Test waiting room', 'title' => ''], + 'WaitingRoomType' => ['description' => 'The type of the waiting room. Valid values:'."\n" + ."\n" + .'- default'."\n" + ."\n" + .'- custom', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'CustomPageHtml' => ['description' => 'The HTML content or identifier of the custom queuing page. This parameter is valid only when `WaitingRoomType` is set to `custom`. The content must be URL-encoded.', 'type' => 'string', 'example' => 'Custom HTML content', 'title' => ''], + 'Language' => ['description' => 'The language of the waiting room page. This parameter is returned when the waiting room type is set to default. Valid values:'."\n" + ."\n" + .'- enus: English.'."\n" + ."\n" + .'- zhcn: Simplified Chinese.'."\n" + ."\n" + .'- zhhk: Traditional Chinese.', 'type' => 'string', 'example' => 'zhcn', 'title' => ''], ], 'title' => '', 'example' => '', @@ -74192,40 +41504,26 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], 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' => '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.', - ], + ['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' => '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.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - '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"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\",\\n \\"WaitingRooms\\": [\\n {\\n \\"WaitingRoomId\\": \\"6a51d5bc6460887abd1291dc7d4d****\\\\n\\",\\n \\"Enable\\": \\"on\\",\\n \\"Name\\": \\"Test waiting room\\",\\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\\": \\"Test waiting room\\",\\n \\"WaitingRoomType\\": \\"default\\",\\n \\"CustomPageHtml\\": \\"Custom HTML content\\",\\n \\"Language\\": \\"zhcn\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListWaitingRooms', - 'description' => 'You can call this operation to query detailed configurations about all waiting rooms in a website, including the status, name, and queuing rules of each waiting room.'."\n", + 'description' => 'Use this operation to query detailed configurations about all waiting rooms in a website, including the status, name, and queuing rules of each waiting room.', 'changeSet' => [ - [ - 'createdAt' => '2024-09-18T06:13:40.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-18T06:13:40.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ListWaitingRooms', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWaitingRooms'], ], ], 'ramActions' => [ @@ -74236,29 +41534,65 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], + 'translator' => 'manual', ], - 'OpenErService' => [ - 'summary' => 'OpenErService', - 'methods' => [ - 'post', + 'OpenEdgeContainer' => [ + 'summary' => 'Activates the edge container service.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '261516', + 'abilityTreeNodes' => ['FEATUREdcdnGMYWU5'], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '54B1C88C-9BB7-568F-9D02-DFBE6F44624D'], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'NoRealNameAuthentication', 'errorMessage' => 'You have not completed real-name authentication.', 'description' => 'You have not completed real-name authentication.'], + ['errorCode' => 'EdgeContainer.HasOpened', 'errorMessage' => 'You have already activated Edge Container.', 'description' => 'You have already activated Edge Container.'], + ['errorCode' => 'UserQuantityExceed', 'errorMessage' => 'Your current purchase quantity exceeds the available quantity. Please select a new quantity.', 'description' => 'Your current purchase quantity exceeds the available quantity. Please select a new quantity.'], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Activate edge container service', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"54B1C88C-9BB7-568F-9D02-DFBE6F44624D\\"\\n}","type":"json"}]', + ], + 'OpenErService' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -74271,9 +41605,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239354', - 'abilityTreeNodes' => [ - 'FEATUREdcdnGMYWU5', - ], + 'abilityTreeNodes' => ['FEATUREdcdnGMYWU5'], ], 'parameters' => [], 'responses' => [ @@ -74283,12 +41615,7 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '5CC228B4-7A67-4016-9C9F-4A4133494A91', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5CC228B4-7A67-4016-9C9F-4A4133494A91'], ], 'example' => '', ], @@ -74296,57 +41623,23 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ErService.HasOpened', - 'errorMessage' => 'You have already activated Edge Routine.', - 'description' => 'You have already activated Edge Routine.', - ], - [ - 'errorCode' => 'InsufficientAvailableQuota', - 'errorMessage' => 'Your account balance is insufficient.', - 'description' => 'Your account is in arrears, please pay the arrears before purchasing.', - ], - [ - 'errorCode' => 'NoRealNameAuthentication', - 'errorMessage' => 'You have not completed real-name authentication.', - 'description' => 'You have not completed real-name authentication.', - ], - [ - 'errorCode' => 'RiskControlRejection', - 'errorMessage' => 'In order to protect the security of your account, the order was suspended, please contact customer service for details.', - 'description' => 'In order to protect the security of your account, the order was suspended, please contact customer service for details.', - ], - [ - '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' => '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.', - ], - [ - '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' => '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.', - ], + ['errorCode' => 'ErService.HasOpened', 'errorMessage' => 'You have already activated Edge Routine.', 'description' => 'You have already activated Edge Routine.'], + ['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account balance is insufficient.', 'description' => 'Your account is in arrears, please pay the arrears before purchasing.'], + ['errorCode' => 'NoRealNameAuthentication', 'errorMessage' => 'You have not completed real-name authentication.', 'description' => 'You have not completed real-name authentication.'], + ['errorCode' => 'RiskControlRejection', 'errorMessage' => 'In order to protect the security of your account, the order was suspended, please contact customer service for details.', 'description' => 'In order to protect the security of your account, the order was suspended, please contact customer service for details.'], + ['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' => '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.'], + ['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' => '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.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CC228B4-7A67-4016-9C9F-4A4133494A91\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'OpenErService', + 'summary' => 'OpenErService', 'changeSet' => [ - [ - 'createdAt' => '2025-06-18T03:30:35.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-06-18T03:30:35.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'OpenErService', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenErService'], ], ], 'ramActions' => [ @@ -74357,25 +41650,17 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CC228B4-7A67-4016-9C9F-4A4133494A91\\"\\n}","type":"json"}]', ], 'PreloadCaches' => [ - 'summary' => 'Prefetches cache.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Prefetches resources.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -74388,37 +41673,23 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239241', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4TTNAL', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4TTNAL'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID. You can call the [ListSites](~~2850189~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456789****', 'title' => ''], ], [ 'name' => 'Content', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The files to be prefetched.'."\n", + 'description' => 'The prefetch objects.', 'type' => 'array', - 'items' => [ - 'description' => 'The single file to be prefetched.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://a.com/1.jpg?b=1', - 'title' => '', - ], + 'items' => ['description' => 'A single prefetch object.'."\n" + .'>The hostname in the URL must be a DNS record name (RecordName) with Proxied=true under the current site specified by SiteId. You can query the record names by calling the ListRecords operation with the SiteId parameter. If you use an unconfigured domain name, the InvalidParameter.RecordNotBelongToSite error is returned.>.', 'type' => 'string', 'required' => false, 'example' => 'http://a.com/1.jpg?b=1', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', @@ -74429,15 +41700,10 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'By default, prefetch requests include the Accept-Encoding:gzip header. If you want a prefetch request to include other headers or implement multi-replica prefetch, you can specify a custom prefetch header by configuring the Headers parameter.'."\n", + 'description' => 'The default header carried in a prefetch request is Accept-Encoding:gzip. If you want the prefetch request to carry other headers or implement multi-copy prefetching, use this parameter to specify custom prefetch headers.', 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The request header.'."\n", - 'example' => 'Accept-Encoding:gzip', - 'title' => '', - ], + 'additionalProperties' => ['description' => '请求头。', 'type' => 'string', 'example' => 'Accept-Encoding:gzip', 'title' => ''], 'title' => '', 'example' => '', ], @@ -74446,22 +41712,12 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9732E117-8A37-49FD-A36F-ABBB87556CA7', - ], - 'TaskId' => [ - 'description' => 'The prefetch task ID.'."\n", - 'type' => 'string', - 'example' => '16401427840', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9732E117-8A37-49FD-A36F-ABBB87556CA7'], + 'TaskId' => ['description' => 'The task ID. A task ID is returned when you create a prefetch task.', 'type' => 'string', 'example' => '16401427840', 'title' => ''], ], 'example' => '', ], @@ -74469,122 +41725,37 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingTimeParameter', - 'errorMessage' => 'The StartTime and EndTime must be both specified.', - 'description' => 'Please provide both a start time and an end time.', - ], - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], - [ - 'errorCode' => 'DomainNameOverLimit', - 'errorMessage' => 'A maximum of 500 domains are supported for each request.', - 'description' => 'Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.', - ], - [ - 'errorCode' => 'InvalidTime', - 'errorMessage' => 'The query time cannot exceed the last 3 days.', - 'description' => 'The query time cannot exceed the last 3 days.', - ], - [ - 'errorCode' => 'MissingParameter.ObjectType', - 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', - 'description' => 'Specify the ObjectType parameter.', - ], - [ - 'errorCode' => 'InvalidStationParameter', - 'errorMessage' => 'The specified Station is invalid.', - 'description' => 'The specified node parameter is invalid.', - ], - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests.Please try again later.', - 'description' => 'Requests are too frequent, please try again later.', - ], - [ - 'errorCode' => 'InvalidTaskId.Malformed', - 'errorMessage' => 'The specified taskId is invalid.', - 'description' => 'The specified task ID is invalid.', - ], - [ - 'errorCode' => 'InvalidParameters.InvalidUrls', - 'errorMessage' => 'The specified urls are invalid.', - 'description' => 'The requested URL parameter is invalid.', - ], - [ - 'errorCode' => 'QuotaExceeded', - 'errorMessage' => 'You attempts have exceeded the daily limit.', - 'description' => 'Exceeding the same day quota limit. The number of submissions today has been exhausted. You can query the number of times a quota can be used today through the quota API.', - ], - [ - 'errorCode' => 'InvalidParameter.RecordNotBelongToSite', - 'errorMessage' => 'The record name passed in does not belong to the current site.', - 'description' => 'The record name passed in does not belong to the current site.', - ], - [ - 'errorCode' => 'PreloadQueueFull', - 'errorMessage' => 'The prefetch queue is full. Try again later.', - 'description' => 'The prefetch queue is full, and you need to retry after the queue is processed.', - ], + ['errorCode' => 'MissingTimeParameter', 'errorMessage' => 'The StartTime and EndTime must be both specified.', 'description' => 'Please provide both a start time and an end time.'], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'DomainNameOverLimit', 'errorMessage' => 'A maximum of 500 domains are supported for each request.', 'description' => 'Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.'], + ['errorCode' => 'InvalidTime', 'errorMessage' => 'The query time cannot exceed the last 3 days.', 'description' => 'The query time cannot exceed the last 3 days.'], + ['errorCode' => 'MissingParameter.ObjectType', 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', 'description' => 'Specify the ObjectType parameter.'], + ['errorCode' => 'InvalidStationParameter', 'errorMessage' => 'The specified Station is invalid.', 'description' => 'The specified node parameter is invalid.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], + ['errorCode' => 'InvalidTaskId.Malformed', 'errorMessage' => 'The specified taskId is invalid.', 'description' => 'The specified task ID is invalid.'], + ['errorCode' => 'InvalidParameters.InvalidUrls', 'errorMessage' => 'The specified urls are invalid.', 'description' => 'The requested URL parameter is invalid.'], + ['errorCode' => 'QuotaExceeded', 'errorMessage' => 'You attempts have exceeded the daily limit.', 'description' => 'Exceeding the same day quota limit. The number of submissions today has been exhausted. You can query the number of times a quota can be used today through the quota API.'], + ['errorCode' => 'InvalidParameter.RecordNotBelongToSite', 'errorMessage' => 'The record name passed in does not belong to the current site.', 'description' => 'The record name passed in does not belong to the current site.'], + ['errorCode' => 'PreloadQueueFull', 'errorMessage' => 'The prefetch queue is full. Try again later.', 'description' => 'The prefetch queue is full, and you need to retry after the queue is processed.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9732E117-8A37-49FD-A36F-ABBB87556CA7\\",\\n \\"TaskId\\": \\"16401427840\\"\\n}","type":"json"}]', - 'title' => 'PreloadCaches', + 'title' => 'Prefetch uRLs', 'changeSet' => [ - [ - 'createdAt' => '2025-06-17T01:55:08.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2025-03-13T07:58:30.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-10-15T01:58:27.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-06-17T01:55:08.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2025-03-13T07:58:30.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-10-15T01:58:27.000Z', 'description' => 'Error codes changed'], ], '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}', - ], - ], - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PreloadCaches'], ], ], + 'ramActions' => [], ], 'PublishEdgeContainerAppVersion' => [ - 'summary' => 'Releases a specific version of a containerized application. You can call this operation to iterate an application.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -74596,89 +41767,44 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239213', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'app-88068867578379****', - 'maxLength' => 64, - 'minLength' => 20, - 'title' => '', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 20, 'example' => 'app-88068867578379****', 'title' => ''], ], [ 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The version ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ver-87962637161651****', - 'maxLength' => 64, - 'minLength' => 20, - 'title' => '', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 20, 'example' => 'ver-87962637161651****', 'title' => ''], ], [ 'name' => 'PublishEnv', 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment to which you want to release the version. Valid values:'."\n" - ."\n" - .'* prod: the production environment.'."\n" - .'* staging: the staging environment.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'prod', - 'title' => '', - ], + 'schema' => ['description' => 'The environment to which you want to release the version. Valid values:'."\n" + ."\n" + .'- prod: the production environment.'."\n" + ."\n" + .'- staging: the staging environment.', 'type' => 'string', 'required' => true, 'example' => 'prod', 'title' => ''], ], [ 'name' => 'Percentage', 'in' => 'formData', - 'schema' => [ - 'description' => 'The release percentage. Valid values: 1 to 100. Default value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '100', - 'title' => '', - ], + 'schema' => ['description' => 'The release percentage. Valid values: 1 to 100. Default value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '100', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'formData', - 'schema' => [ - 'description' => 'The time when the application version starts to be released. If you do not specify this parameter, the current time is used by default.'."\n" - ."\n" - .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2023-06-05T16:00:00Z', - 'title' => '', - ], + 'schema' => ['description' => 'The time when the application version starts to be released. If you do not specify this parameter, the current time is used by default.'."\n" + ."\n" + .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.', 'type' => 'string', 'required' => false, 'example' => '2023-06-05T16:00:00Z', 'title' => ''], ], [ 'name' => 'Remarks', 'in' => 'formData', - 'schema' => [ - 'description' => 'The remarks. This parameter is empty by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test publish app', - 'maxLength' => 1024, - 'title' => '', - ], + 'schema' => ['description' => 'The remarks. This parameter is empty by default.', 'type' => 'string', 'required' => false, 'maxLength' => 1024, 'example' => 'test publish app', 'title' => ''], ], [ 'name' => 'PublishType', @@ -74686,18 +41812,16 @@ 'schema' => [ 'description' => 'Specifies how the version is released. Valid values:'."\n" ."\n" - .'* percentage: releases the version by percentage.'."\n" - .'* region: releases the version by region.'."\n" + .'- percentage: releases the version by percentage.'."\n" + ."\n" + .'- region: releases the version by region.'."\n" ."\n" - .'If you do not specify this parameter, the version is released by percentage by default.'."\n", + .'If you do not specify this parameter, the version is released by percentage by default.', 'type' => 'string', + 'default' => 'percentage', + 'enum' => ['percentage', 'region'], 'required' => false, 'example' => 'percentage', - 'default' => 'percentage', - 'enum' => [ - 'percentage', - 'region', - ], 'title' => '', ], ], @@ -74706,15 +41830,9 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The regions to which the version is released.'."\n", + 'description' => 'The regions to which the version is released.', 'type' => 'array', - 'items' => [ - 'description' => 'The release region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'jiangsu', - 'title' => '', - ], + 'items' => ['description' => 'The release region.', 'type' => 'string', 'required' => false, 'example' => 'jiangsu', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', @@ -74723,14 +41841,7 @@ [ 'name' => 'FullRelease', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to fully release the version. This parameter takes effect only when PublishType is set to region.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to fully release the version. This parameter takes effect only when PublishType is set to region.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ @@ -74738,12 +41849,7 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', 'title' => ''], ], 'description' => '', 'title' => '', @@ -74753,67 +41859,30 @@ ], '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' => 'The PublishEnv parameter is invalid. Please check the PublishEnv parameter. You may not have set it to prod or staging one of them. Please modify it and call the interface again.', - ], - [ - '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' => 'The Percentage parameter is invalid. Check the Percentage parameter. The parameter range is 1-100. Modify the parameter and call the interface again.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', - 'description' => 'Invalid parameter. Check the parameter configuration.', - ], - [ - 'errorCode' => 'InvalidParameter.appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'The VersionId parameter 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.', - ], + ['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' => 'The PublishEnv parameter is invalid. Please check the PublishEnv parameter. You may not have set it to prod or staging one of them. Please modify it and call the interface again.'], + ['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' => 'The Percentage parameter is invalid. Check the Percentage parameter. The parameter range is 1-100. Modify the parameter and call the interface again.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', 'description' => 'Invalid parameter. Check the parameter configuration.'], + ['errorCode' => 'InvalidParameter.appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'The VersionId parameter 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.'], ], 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', 'title' => 'PublishEdgeContainerAppVersion', + 'summary' => 'Releases a specific version of a containerized application.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'PublishEdgeContainerAppVersion', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishEdgeContainerAppVersion'], ], ], 'ramActions' => [ @@ -74824,107 +41893,224 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', ], - 'PurchaseCacheReserve' => [ - 'summary' => 'New Purchase of Cache Retention', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PublishRoutineCodeVersion' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '238733', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '238829', + 'abilityTreeNodes' => ['FEATUREdcdn75UYDO'], ], 'parameters' => [ [ - 'name' => 'QuotaGb', - 'in' => 'query', - 'schema' => [ - 'description' => 'Cache retention specification (unit: GB).', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '512000', - 'title' => '', - ], + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the Edge Routine.', 'type' => 'string', 'required' => true, 'example' => 'test-routine1', 'title' => ''], ], [ - 'name' => 'CrRegion', - 'in' => 'query', - 'schema' => [ - 'description' => 'Cache retention region'."\n" - .'- HK: Hong Kong, China'."\n" - .'- CN-beijing: Mainland China - Beijing', - 'type' => 'string', - 'required' => false, - 'example' => 'HK', - 'title' => '', - ], + 'name' => 'Env', + 'in' => 'formData', + 'schema' => ['description' => 'The environment name.', 'type' => 'string', 'required' => true, 'example' => 'production', 'title' => ''], ], [ - 'name' => 'AutoRenew', - 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to auto-renew:'."\n" - .'- true: Auto-renew.'."\n" - .'- false: Do not auto-renew.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'name' => 'CodeVersion', + 'in' => 'formData', + 'schema' => ['description' => 'The version number of the code to publish.', 'type' => 'string', 'required' => false, 'example' => '1710120201067203242', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395'], + 'CodeVersion' => ['description' => 'The code version number.', 'type' => 'string', 'example' => '1710120201067203242', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'RoutineNotExist', 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', 'description' => 'The routine name does not exist. Check the routine name and try again.'], + ['errorCode' => 'ParameterNotExist', 'errorMessage' => 'The specified parameter does not exist. Check your configurations and try again.', 'description' => 'The specified parameter does not exist. Check your configurations and try again.'], + ['errorCode' => 'InternalOperationError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'DependedByOthers', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'RoutineUserServiceStatusHalt', 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', 'description' => 'Failed to update the configurations because you have overdue payments.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter verification failed. Check your configurations and try again.', 'description' => 'Parameter verification failed. Check your configurations and try again.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Publish a specific version of edge routine code', + 'summary' => 'Publishes a specific version of Edge Routine code to a staging or production environment. When publishing to the production environment, you can perform a canary release to specific regions.', + 'changeSet' => [ + ['createdAt' => '2024-12-04T05:48:47.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Period', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:PublishRoutineCodeVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"CodeVersion\\": \\"1710120201067203242\\"\\n}","type":"json"}]', + ], + 'PurchaseBotInstance' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238733', + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], + ], + 'parameters' => [ + [ + 'name' => 'SiteInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The site instance.', 'type' => 'string', 'required' => true, 'example' => 'esa-site-23kde*****'."\n", 'title' => ''], + ], + [ + 'name' => 'BotInstanceLevel', 'in' => 'query', 'schema' => [ - 'description' => 'Purchase period (unit: month).', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', + 'description' => 'The bot instance specifications.', + 'enumValueTitles' => ['enterprise_bot' => 'Web edition.', 'enterprise_bot_with_app' => 'Web/App edition.'], + 'type' => 'string', + 'required' => true, + 'enum' => ['enterprise_bot', 'enterprise_bot_with_app'], + 'example' => 'enterprise_bot', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ 'title' => '', + 'description' => 'The response struct.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n"], + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '31223****11', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'esa-bot-9v9x3o2***', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'CheckOrderFailed', 'errorMessage' => 'Invalid order parameter.', 'description' => 'Invalid order parameter.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.'], + ['errorCode' => 'InvalidSiteName', 'errorMessage' => 'Invalid website name. Check and try again.', 'description' => 'Invalid website name. Check and try again.'], + ['errorCode' => 'SYSTEM.NoSpecificCodeFailed', 'errorMessage' => 'Invalid subscription duration. Check and try again.', 'description' => 'Invalid subscription duration. Check and try again.'], + ['errorCode' => 'CheckPlanFailed', 'errorMessage' => 'Invalid plan name or code. Check and try again.', 'description' => 'Invalid plan name or code. Check and try again.'], + ['errorCode' => 'SubSiteUnavailable', 'errorMessage' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.', 'description' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.'], + ['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account balance is insufficient.', 'description' => 'Your account is in arrears, please pay the arrears before purchasing.'], + ['errorCode' => 'InsufficientBalance', 'errorMessage' => 'Your account balance is insufficient.', 'description' => 'Your account balance is insufficient, please recharge before purchasing.'], + ['errorCode' => 'InvalidComponent', 'errorMessage' => 'The order parameters is invalid.', 'description' => 'The order parameters is invalid.'], + ['errorCode' => 'RamAuthFailed', 'errorMessage' => 'The sub-account has no operation permission.', 'description' => 'The RAM user does not have the required operation permissions.'], + ], + ], + 'title' => 'Purchase a bot instance', + 'summary' => 'Purchases a new bot instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\\\n\\",\\n \\"OrderId\\": \\"31223****11\\",\\n \\"InstanceId\\": \\"esa-bot-9v9x3o2***\\"\\n}","type":"json"}]', + ], + 'PurchaseCacheReserve' => [ + 'summary' => 'Purchases a cache reserve instance.', + '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' => 'The cache reserve specification. Unit: GB.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '512000', 'title' => ''], + ], + [ + 'name' => 'CrRegion', + 'in' => 'query', + 'schema' => ['description' => 'The cache reserve region.'."\n" + .'- HK: Hong Kong (China)'."\n" + .'- CN-beijing: Chinese mainland - Beijing', 'type' => 'string', 'required' => false, 'example' => 'HK', 'title' => ''], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n" + .'- true: Enables auto-renewal.'."\n" + .'- false: Disables auto-renewal.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => 'The purchase period. Unit: months.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ - 'description' => 'Billing type'."\n" - .'- PREPAY: Prepaid.'."\n" - .'- POSTPAY: Postpaid.', + 'description' => 'The billing type. Valid values:'."\n" + .'- PREPAY: upfront.', + 'enumValueTitles' => ['PREPAY' => 'Upfront.'], 'type' => 'string', + 'enum' => ['POSTPAY', 'PREPAY'], 'required' => false, 'example' => 'PREPAY', - 'enum' => [ - 'POSTPAY', - 'PREPAY', - ], 'title' => '', ], ], @@ -74932,17 +42118,14 @@ 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ - 'description' => 'Whether to automatically pay. The default value is false.'."\n" - .'- true: Automatically pay.'."\n" - .'- false: Do not automatically pay.', + 'description' => 'Specifies whether to enable automatic payment. Default value: false. Valid values:'."\n" + .'- true: Enables automatic payment.'."\n" + .'- false: Disables automatic payment.', + 'enumValueTitles' => ['true' => 'automatic payment.', 'false' => 'no automatic payment.'], 'type' => 'boolean', + 'default' => 'false', 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], 'example' => 'true', - 'default' => 'false', 'title' => '', ], ], @@ -74950,28 +42133,13 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Response structure.', + 'title' => '', + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '30423A7F-A83D-1E24-B80E-86DD25790758', - ], - 'OrderId' => [ - 'description' => 'Order ID.', - 'type' => 'string', - 'example' => '31223****11', - 'title' => '', - ], - 'InstanceId' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'example' => 'xcdn-ad*****s11w'."\n", - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '30423A7F-A83D-1E24-B80E-86DD25790758'], + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '31223****11', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'xcdn-ad*****s11w'."\n", 'title' => ''], ], 'example' => '', ], @@ -74979,74 +42147,28 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CheckOrderFailed', - 'errorMessage' => 'Invalid order parameter.', - 'description' => 'Invalid order parameter.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], - [ - '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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.', - ], - [ - 'errorCode' => 'InvalidSiteName', - 'errorMessage' => 'Invalid website name. Check and try again.', - 'description' => 'Invalid website name. Check and try again.', - ], - [ - 'errorCode' => 'SYSTEM.NoSpecificCodeFailed', - 'errorMessage' => 'Invalid subscription duration. Check and try again.', - 'description' => 'Invalid subscription duration. Check and try again.', - ], - [ - 'errorCode' => 'CheckPlanFailed', - 'errorMessage' => 'Invalid plan name or code. Check and try again.', - 'description' => 'Invalid plan name or code. Check and try again.', - ], - [ - 'errorCode' => 'SubSiteUnavailable', - 'errorMessage' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.', - 'description' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.', - ], - [ - 'errorCode' => 'InsufficientAvailableQuota', - 'errorMessage' => 'Your account balance is insufficient.', - 'description' => 'Your account is in arrears, please pay the arrears before purchasing.', - ], - [ - 'errorCode' => 'InsufficientBalance', - 'errorMessage' => 'Your account balance is insufficient.', - 'description' => 'Your account balance is insufficient, please recharge before purchasing.', - ], - [ - 'errorCode' => 'InvalidComponent', - 'errorMessage' => 'The order parameters is invalid.', - 'description' => 'The order parameters is invalid.', - ], - [ - 'errorCode' => 'RamAuthFailed', - 'errorMessage' => 'The sub-account has no operation permission.', - 'description' => '', - ], + ['errorCode' => 'CheckOrderFailed', 'errorMessage' => 'Invalid order parameter.', 'description' => 'Invalid order parameter.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.'], + ['errorCode' => 'InvalidSiteName', 'errorMessage' => 'Invalid website name. Check and try again.', 'description' => 'Invalid website name. Check and try again.'], + ['errorCode' => 'SYSTEM.NoSpecificCodeFailed', 'errorMessage' => 'Invalid subscription duration. Check and try again.', 'description' => 'Invalid subscription duration. Check and try again.'], + ['errorCode' => 'CheckPlanFailed', 'errorMessage' => 'Invalid plan name or code. Check and try again.', 'description' => 'Invalid plan name or code. Check and try again.'], + ['errorCode' => 'SubSiteUnavailable', 'errorMessage' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.', 'description' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.'], + ['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account balance is insufficient.', 'description' => 'Your account is in arrears, please pay the arrears before purchasing.'], + ['errorCode' => 'InsufficientBalance', 'errorMessage' => 'Your account balance is insufficient.', 'description' => 'Your account balance is insufficient, please recharge before purchasing.'], + ['errorCode' => 'InvalidComponent', 'errorMessage' => 'The order parameters is invalid.', 'description' => 'The order parameters is invalid.'], + ['errorCode' => 'RamAuthFailed', 'errorMessage' => 'The sub-account has no operation permission.', 'description' => 'The RAM user does not have the required operation permissions.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30423A7F-A83D-1E24-B80E-86DD25790758\\",\\n \\"OrderId\\": \\"31223****11\\",\\n \\"InstanceId\\": \\"xcdn-ad*****s11w\\\\n\\"\\n}","type":"json"}]', - 'title' => 'Purchase Cache Retention', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'Purchase a cache reserve instance', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'PurchaseCacheReserve', - ], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PurchaseCacheReserve'], ], ], 'ramActions' => [ @@ -75057,27 +42179,16 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'PurchaseRatePlan' => [ - 'summary' => 'Purchase New Package', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Purchases a plan by calling PurchaseRatePlan.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -75089,185 +42200,132 @@ 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '239597', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'PlanName', 'in' => 'query', - 'schema' => [ - 'description' => 'Package name.', - 'type' => 'string', - 'required' => false, - 'example' => 'basic', - 'title' => '', - ], + 'schema' => ['description' => 'The plan name.'."\n" + ."\n" + .'China site'."\n" + ."\n" + .'- Free Edition: entranceplan'."\n" + .'- Basic: basic'."\n" + .'- Standard: medium'."\n" + .'- Premium: high'."\n" + ."\n" + .'International site'."\n" + ."\n" + .'- Entrance: entranceplan_intl'."\n" + .'- Pro: basicplan_intl'."\n" + .'- Premium: vipplan_intl'."\n" + ."\n" + .'> Note: For Enterprise Edition plans, the plan name is provided after backend configuration.', 'type' => 'string', 'required' => false, 'example' => 'basic', 'title' => ''], ], [ 'name' => 'PlanCode', 'in' => 'query', - 'schema' => [ - 'description' => 'Package code.', - 'type' => 'string', - 'required' => false, - 'example' => 'basicplan', - 'title' => '', - ], + 'schema' => ['description' => 'The plan code.'."\n" + ."\n" + .'China site'."\n" + ."\n" + .'- Free Edition: entranceplan'."\n" + .'- Basic: basicplan'."\n" + .'- Standard: standardplan'."\n" + .'- Premium: advancedplan'."\n" + ."\n" + .'International site'."\n" + ."\n" + .'- Entrance: entranceplan'."\n" + .'- Pro: standardplan'."\n" + .'- Premium: advancedpla.', 'type' => 'string', 'required' => false, 'example' => 'basicplan', 'title' => ''], ], [ 'name' => 'SiteName', 'in' => 'query', - 'schema' => [ - 'description' => 'Site name.', - 'type' => 'string', - 'required' => false, - 'example' => 'test.com', - 'title' => '', - ], + 'schema' => ['description' => 'The site name.', 'type' => 'string', 'required' => false, 'example' => 'test.com', 'title' => ''], ], [ 'name' => 'Coverage', 'in' => 'query', - 'schema' => [ - 'description' => 'The service location. Valid values:'."\n" - ."\n" - .'* domestic: the Chinese mainland.'."\n" - .'* global: global.'."\n" - .'* overseas: outside the Chinese mainland.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'domestic', - 'default' => 'overseas', - 'title' => '', - ], + 'schema' => ['description' => 'The acceleration region. Valid values:'."\n" + .'- domestic: the Chinese mainland only.'."\n" + .'- global: global.'."\n" + .'- overseas: global (excluding the Chinese mainland).', 'type' => 'string', 'default' => 'overseas', 'required' => false, 'example' => 'domestic', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => 'The DNS setup option for the website. Valid values:'."\n" - ."\n" - .'* NS'."\n" - .'* CNAME'."\n", + 'description' => 'The site access type. Valid values:'."\n" + .'- NS: NS access.'."\n" + .'- CNAME: CNAME access.', + 'enumValueTitles' => ['NS' => 'NS access.', 'CNAME' => 'CNAME access.'], 'type' => 'string', + 'default' => 'CNAME', + 'enum' => ['CNAME', 'NS'], 'required' => false, 'example' => 'CNAME', - 'default' => 'CNAME', - 'enum' => [ - 'CNAME', - 'NS', - ], 'title' => '', ], ], [ 'name' => 'AutoRenew', 'in' => 'query', - 'schema' => [ - 'description' => 'Auto-renewal:'."\n" - .'- true: Enable auto-renewal.'."\n" - .'- false: Disable auto-renewal.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n" + .'- true: Auto-renewal is enabled.'."\n" + .'- false: Auto-renewal is disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'Subscription period (in months).', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The purchase period, in months.'."\n" + .'This parameter is required when you directly call this operation.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* PREPAY: subscription.'."\n" - .'* POSTPAY: pay-as-you-go.'."\n", + .'- PREPAY: subscription.'."\n" + .'- POSTPAY: pay-as-you-go.'."\n" + .'Set this parameter to PREPAY when you directly call this operation.', + 'enumValueTitles' => ['POSTPAY' => 'Subscription.', 'PREPAY' => 'Pay-as-you-go.'], 'type' => 'string', + 'enum' => ['POSTPAY', 'PREPAY'], 'required' => false, 'example' => 'PREPAY', - 'enum' => [ - 'POSTPAY', - 'PREPAY', - ], 'title' => '', ], ], [ 'name' => 'AutoPay', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable auto payment.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable automatic payment.'."\n" + .'Set this parameter to true when you directly call this operation.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'Amount', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '99', - 'minimum' => '1', - 'description' => 'Quantity of the package to purchase. ', - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The number of plans to purchase.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '99', 'minimum' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'Channel', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'required' => false, - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The channel field.', 'type' => 'string', 'required' => false, 'example' => 'xxxWodkxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Response structure.', + 'title' => '', + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '30423A7F-A83D-1E24-B80E-86DD25790758', - ], - 'OrderId' => [ - 'description' => 'Order ID.', - 'type' => 'string', - 'example' => '123123', - 'title' => '', - ], - 'InstanceId' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'example' => 'esa-site-ads11w', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '30423A7F-A83D-1E24-B80E-86DD25790758'], + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '123123', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'esa-site-ads11w', 'title' => ''], ], 'example' => '', ], @@ -75275,161 +42333,47 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CheckOrderFailed', - 'errorMessage' => 'Invalid order parameter.', - 'description' => 'Invalid order parameter.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], - [ - '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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.', - ], - [ - 'errorCode' => 'InvalidSiteName', - 'errorMessage' => 'Invalid website name. Check and try again.', - 'description' => 'Invalid website name. Check and try again.', - ], - [ - 'errorCode' => 'SYSTEM.NoSpecificCodeFailed', - 'errorMessage' => 'Invalid subscription duration. Check and try again.', - 'description' => 'Invalid subscription duration. Check and try again.', - ], - [ - 'errorCode' => 'CheckPlanFailed', - 'errorMessage' => 'Invalid plan name or code. Check and try again.', - 'description' => 'Invalid plan name or code. Check and try again.', - ], - [ - 'errorCode' => 'SubSiteUnavailable', - 'errorMessage' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.', - 'description' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.', - ], - [ - 'errorCode' => 'InsufficientAvailableQuota', - 'errorMessage' => 'Your account balance is insufficient.', - 'description' => 'Your account is in arrears, please pay the arrears before purchasing.', - ], - [ - 'errorCode' => 'InsufficientBalance', - 'errorMessage' => 'Your account balance is insufficient.', - 'description' => 'Your account balance is insufficient, please recharge before purchasing.', - ], - [ - 'errorCode' => 'InvalidComponent', - 'errorMessage' => 'The order parameters is invalid.', - 'description' => 'The order parameters is invalid.', - ], - [ - 'errorCode' => 'RamAuthFailed', - 'errorMessage' => 'The sub-account has no operation permission.', - 'description' => '', - ], - [ - 'errorCode' => 'BuyWithSiteAmountErr', - 'errorMessage' => 'Site-based purchase plans do not support bulk purchasing.', - 'description' => 'Site-based purchase plans do not support bulk purchasing.', - ], - [ - 'errorCode' => 'EnterpriseAmountErr', - 'errorMessage' => 'Enterprise plans do not support bulk purchase.', - 'description' => 'Enterprise plans do not support bulk purchase.', - ], - [ - 'errorCode' => 'TrialService.HasOpened', - 'errorMessage' => 'You have already activated the trial service.', - 'description' => 'You have activated the trial service and cannot activate it again.', - ], - [ - 'errorCode' => 'UserQuantityExceed', - 'errorMessage' => 'Your current purchase quantity exceeds the available quantity. Please select a new quantity.', - 'description' => 'Your current purchase quantity exceeds the available quantity. Please select a new quantity.', - ], - [ - 'errorCode' => 'BASIC_INFO_UNCOMPLETED', - 'errorMessage' => 'You have not completed your personal basic information. Please complete the information and try again.', - 'description' => 'You have not completed your basic personal information. Please complete the information and re-operate. (If the current account is a managed sub-account, please contact the main account and click this link to complete the information.) [ - [ - 'createdAt' => '2025-06-18T03:30:35.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2025-06-13T03:33:33.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2025-04-08T06:39:34.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2025-02-20T05:44:58.000Z', - 'description' => 'Error codes changed, Request parameters changed', - ], - [ - 'createdAt' => '2024-09-18T06:13:40.000Z', - 'description' => 'Error codes changed', + ['errorCode' => 'CheckOrderFailed', 'errorMessage' => 'Invalid order parameter.', 'description' => 'Invalid order parameter.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.'], + ['errorCode' => 'InvalidSiteName', 'errorMessage' => 'Invalid website name. Check and try again.', 'description' => 'Invalid website name. Check and try again.'], + ['errorCode' => 'SYSTEM.NoSpecificCodeFailed', 'errorMessage' => 'Invalid subscription duration. Check and try again.', 'description' => 'Invalid subscription duration. Check and try again.'], + ['errorCode' => 'CheckPlanFailed', 'errorMessage' => 'Invalid plan name or code. Check and try again.', 'description' => 'Invalid plan name or code. Check and try again.'], + ['errorCode' => 'SubSiteUnavailable', 'errorMessage' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.', 'description' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.'], + ['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account balance is insufficient.', 'description' => 'Your account is in arrears, please pay the arrears before purchasing.'], + ['errorCode' => 'InsufficientBalance', 'errorMessage' => 'Your account balance is insufficient.', 'description' => 'Your account balance is insufficient, please recharge before purchasing.'], + ['errorCode' => 'InvalidComponent', 'errorMessage' => 'The order parameters is invalid.', 'description' => 'The order parameters is invalid.'], + ['errorCode' => 'RamAuthFailed', 'errorMessage' => 'The sub-account has no operation permission.', 'description' => ''], + ['errorCode' => 'BuyWithSiteAmountErr', 'errorMessage' => 'Site-based purchase plans do not support bulk purchasing.', 'description' => 'Site-based purchase plans do not support bulk purchasing.'], + ['errorCode' => 'EnterpriseAmountErr', 'errorMessage' => 'Enterprise plans do not support bulk purchase.', 'description' => 'Enterprise plans do not support bulk purchase.'], + ['errorCode' => 'TrialService.HasOpened', 'errorMessage' => 'You have already activated the trial service.', 'description' => 'You have activated the trial service and cannot activate it again.'], + ['errorCode' => 'UserQuantityExceed', 'errorMessage' => 'Your current purchase quantity exceeds the available quantity. Please select a new quantity.', 'description' => 'Your current purchase quantity exceeds the available quantity. Please select a new quantity.'], + ['errorCode' => 'BASIC_INFO_UNCOMPLETED', 'errorMessage' => 'You have not completed your personal basic information. Please complete the information and try again.', 'description' => 'You have not completed your basic personal information. Please complete the information and re-operate. (If the current account is a managed sub-account, please contact the main account and click this link to complete the information.) 'Purchase a plan', + 'description' => '1. Obtain the plan name and plan code by calling the DescribeRatePlanPrice operation.'."\n" + .'2. If the acceleration region is not set to overseas, the site must have a valid China Internet Content Provider (ICP) filing.', + 'changeSet' => [ + ['createdAt' => '2025-06-18T03:30:35.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2025-06-13T03:33:33.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2025-04-08T06:39:34.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2025-02-20T05:44:58.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2024-09-18T06:13:40.000Z', 'description' => 'Error codes changed'], + ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'PurchaseRatePlan', - ], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PurchaseRatePlan'], ], ], 'ramActions' => [ @@ -75440,27 +42384,16 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30423A7F-A83D-1E24-B80E-86DD25790758\\",\\n \\"OrderId\\": \\"123123\\",\\n \\"InstanceId\\": \\"esa-site-ads11w\\"\\n}","type":"json"}]', - 'translator' => 'machine', ], 'PurgeCaches' => [ - 'summary' => 'Purges resources cached on points of presence (POPs). You can purge the cache by file URL, directory, cache tag, hostname, or URL with specified parameters ignored, or purge all the cache.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Refreshes file content on nodes. Supports refreshing by file, directory, cache tag, ignored parameters, hostname, and entire site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -75473,52 +42406,31 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238881', - 'abilityTreeNodes' => [ - 'FEATUREdcdnBCJPGN', - 'FEATUREdcdnELTTM1', - 'FEATUREdcdnA9FG2P', - 'FEATUREdcdnRELTJV', - 'FEATUREdcdnEWYS3A', - 'FEATUREdcdn4QVGXU', - ], + 'abilityTreeNodes' => ['FEATUREdcdnBCJPGN', 'FEATUREdcdnELTTM1', 'FEATUREdcdnA9FG2P', 'FEATUREdcdnRELTJV', 'FEATUREdcdnEWYS3A', 'FEATUREdcdn4QVGXU'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => 'The type of refresh task. Possible values:'."\n" - .'- **file** (default): File refresh.'."\n" - .'- **cachekey**: Cachekey refresh.'."\n" - .'- **cachetag**: Cachetag refresh.'."\n" - .'- **directory**: Directory refresh.'."\n" - .'- **ignoreParams**: Ignore parameters refresh. Ignoring parameters means removing the ? and everything after it in the request URL. When performing an ignore parameters refresh, the user first submits the URL without parameters through the interface. The submitted URLs to be refreshed will then be matched against the cached resource URLs with the parameters removed. If the cached resource URL, after removing the parameters, matches the URL to be refreshed, the CDN node will refresh the cached resources.'."\n" - .'- **hostname**: Hostname refresh.'."\n" - .'- **purgeall**: Purge all cache under the site.', + 'description' => 'The type of the refresh node. Valid values:'."\n" + .'- **file** (default): file refresh.'."\n" + .'- **cachekey**: cache key refresh.'."\n" + .'- **cachetag**: cache label refresh.'."\n" + .'- **directory**: folder refresh.'."\n" + .'- **ignoreParams**: parameter-ignored refresh. This refers to removing the question mark (?) and all parameters after it from the request URL. When you commit a parameter-stripped URL through this API operation, the submitted URL is matched against cached resource URLs after their parameters are also stripped. If a cached resource URL matches the submitted URL after parameter stripping, the point of presence executes the refresh on the cached resource.'."\n" + .'- **hostname**: hostname refresh.'."\n" + .'- **purgeall**: refreshes all cached content under the site.', + 'enumValueTitles' => ['cachetag' => 'cache tag refresh.', 'hostname' => 'hostname refresh.', 'file' => 'file refresh.', 'cachekey' => 'cache key refresh.', 'purgeall' => 'refreshes all cached content under the site.', 'ignoreparams' => 'parameter-ignored refresh.', 'directory' => 'directory refresh.'], 'type' => 'string', 'required' => true, + 'enum' => ['file', 'cachetag', 'directory', 'ignoreparams', 'hostname', 'purgeall', 'cachekey'], 'example' => 'file', - 'enum' => [ - 'file', - 'cachetag', - 'directory', - 'ignoreparams', - 'hostname', - 'purgeall', - 'cachekey', - ], 'title' => '', ], ], @@ -75527,129 +42439,87 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'Content to be refreshed.', + 'description' => 'The refresh content.', 'type' => 'object', 'properties' => [ 'Files' => [ - 'description' => 'List of files to be refreshed, required when the type is file.', + 'description' => 'The list of files to refresh. This parameter is required when Type is set to file.', 'type' => 'array', - 'items' => [ - 'description' => 'List of files to be refreshed, required when the type is file.'."\n" - ."\n" - .'> Up to 1000 items per request, and up to 10 different domains.', - 'type' => 'any', - 'required' => false, - 'example' => '["http://a.com/1.jpg?b=1", "http://a.com/2.jpg?b=1"]', - 'title' => '', - ], + 'items' => ['description' => 'The list of files to refresh. This parameter is required when Type is set to file.'."\n" + ."\n" + .'> A maximum of 1,000 entries are allowed per request, with a maximum of 10 different domain names.', 'type' => 'any', 'required' => false, 'example' => '["http://a.com/1.jpg?b=1", "http://a.com/2.jpg?b=1"]', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'CacheTags' => [ - 'description' => 'List of cachetags to be refreshed, required when the type is cachetag.', + 'description' => 'The list of cache tags to refresh. This parameter is required when Type is set to cachetag.', 'type' => 'array', - 'items' => [ - 'description' => 'List of cachetags to be refreshed, required when the type is cachetag.'."\n" - ."\n" - .'> Up to 30 items per request.', - 'type' => 'string', - 'required' => false, - 'example' => '["tag1", "tag2"]', - 'title' => '', - ], + 'items' => ['description' => 'The list of cache tags to refresh. This parameter is required when Type is set to cachetag.'."\n" + ."\n" + .'> A maximum of 30 entries are allowed per request.', 'type' => 'string', 'required' => false, 'example' => '["tag1", "tag2"]', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'Hostnames' => [ - 'description' => 'List of hostnames to be refreshed, required when the type is hostname.', + 'description' => 'The list of hostnames to refresh. This parameter is required when Type is set to hostname.', 'type' => 'array', - 'items' => [ - 'description' => 'List of hostnames to be refreshed, required when the type is hostname.'."\n" - .'> Up to 10 domains per request.', - 'type' => 'string', - 'required' => false, - 'example' => '["a.com", "b.com"]', - 'title' => '', - ], + 'items' => ['description' => 'The list of hostnames to refresh. This parameter is required when Type is set to hostname.'."\n" + .'> A maximum of 10 domain names are allowed per request.', 'type' => 'string', 'required' => false, 'example' => '["a.com", "b.com"]', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'IgnoreParams' => [ - 'description' => 'List of files with ignored parameters, required when the type is ignoreParams.', + 'description' => 'The list of files with parameters ignored. This parameter is required when Type is set to ignoreParams.', 'type' => 'array', - 'items' => [ - 'description' => 'List of files with ignored parameters, required when the type is ignoreParams.'."\n" - ."\n" - .'> Up to 100 items per request, and up to 10 different domains.', - 'type' => 'string', - 'required' => false, - 'example' => '["http://a.com/1.jpg", "http://a.com/2.jpg"]', - 'title' => '', - ], + 'items' => ['description' => 'The list of files with parameters ignored. This parameter is required when Type is set to ignoreParams.'."\n" + ."\n" + .'> A maximum of 100 entries are allowed per request, with a maximum of 10 different domain names.', 'type' => 'string', 'required' => false, 'example' => '["http://a.com/1.jpg", "http://a.com/2.jpg"]', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'Directories' => [ - 'description' => 'List of directories to be refreshed, required when the type is directory.', + 'description' => 'The list of directories to refresh. This parameter is required when Type is set to directory.', 'type' => 'array', - 'items' => [ - 'description' => 'List of directories to be refreshed, required when the type is directory.'."\n" - ."\n" - .'> Up to 100 items per request, and up to 10 different domains.', - 'type' => 'string', - 'required' => false, - 'example' => '["http://a.com/path1/", "http://a.com/path2/"]', - 'title' => '', - ], + 'items' => ['description' => 'The list of directories to refresh. This parameter is required when Type is set to directory.'."\n" + ."\n" + .'> A maximum of 100 entries are allowed per request, with a maximum of 10 different domain names.', 'type' => 'string', 'required' => false, 'example' => '["http://a.com/path1/", "http://a.com/path2/"]', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], - 'PurgeAll' => [ - 'description' => 'Flag for purging all content. Default is false, set to true when the type is purgeall.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], + 'PurgeAll' => ['description' => 'Specifies whether to refresh all cached content under the site. Default value: false. Set this parameter to true when Type is set to purgeall.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'CacheKeys' => [ - 'description' => 'List of cachekeys to be refreshed, required when the type is cachekey.', + 'description' => 'The list of cache keys to refresh. This parameter is required when Type is set to cachekey.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Url' => [ - 'description' => 'URL address to be refreshed.', - 'type' => 'string', - 'required' => false, - 'example' => 'http://a.com/1.jpg?b=1', - 'title' => '', - ], + 'Url' => ['description' => 'The URL to refresh.', 'type' => 'string', 'required' => false, 'example' => 'http://a.com/1.jpg?b=1', 'title' => ''], 'Headers' => [ - 'description' => 'When refreshing, specify the header information corresponding to the cache key. When the custom cache key feature switch is enabled, the cache key will be generated based on the specified header for refreshing.'."\n" + 'description' => 'The header information corresponding to the cache key for the refresh. When the custom cache key feature is enabled, the cache key is generated based on the specified headers for the refresh.'."\n" + ."\n" + .'**UserGeo: country/region**'."\n" ."\n" - .'**UserGeo: Country/Region**'."\n" .'- Country/region codes follow the ISO 3166-2 standard.'."\n" ."\n" - .'**UserDeviceType: Device Type, currently there are three enum values**'."\n" + .'**UserDeviceType: device type. Valid values:**'."\n" + ."\n" .'- desktop'."\n" - .' - tablet'."\n" - .' - mobile'."\n" ."\n" - .'**UserLanguage: Language**'."\n" - .'- Language codes follow the ISO 639-1 or BCP47 standards. For example, input \'zh\' to refresh content in Chinese.', + .'- tablet'."\n" + ."\n" + .'- mobile'."\n" + ."\n" + .'**UserLanguage: language**'."\n" + ."\n" + .'- Language codes follow the ISO 639-1 or BCP 47 standard. For example, set this to zh to refresh content in Chinese.', 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The value information corresponding to the cachekey header.', - '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"}}', - 'title' => '', - ], + 'additionalProperties' => ['description' => 'The value of the cache key header.', 'type' => 'string', '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"}}', 'title' => ''], 'title' => '', 'example' => '', ], @@ -75672,50 +42542,28 @@ [ 'name' => 'Force', 'in' => 'query', - 'schema' => [ - 'description' => 'Indicates whether to refresh all resources under the directory when the content from the origin and the source resource are inconsistent. The default is false.'."\n" - .'- **true**: Refreshes all resources under the specified directory.'."\n" - .'- **false**: Refreshes only the changed resources under the specified directory.'."\n" - ."\n" - .'> '."\n" - .'> Applies to: Directory refresh, cachetag refresh, ignoreParams refresh, hostname refresh, and purge all cache of the site.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to refresh all resources under the corresponding directory when the back-to-origin content is inconsistent with the origin server resources. Default value: false.'."\n" + .'- **true**: Refreshes all resources under the corresponding directory.'."\n" + .'- **false**: Refreshes only the changed resources under the corresponding directory.'."\n" + ."\n" + .'> '."\n" + .'> This parameter takes effect for directory refresh, cache tag refresh, parameter-ignored refresh, hostname refresh, and full site cache refresh.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'EdgeComputePurge', 'in' => 'query', - 'schema' => [ - 'description' => 'Used for refreshing cached resources in edge computing, such as allowing the refresh of content cached using the CacheAPI interface of an edge function.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to refresh edge computing cached resources. For example, this allows refreshing content cached by the Edge Routine Cache API operation function.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of the response', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'ET5BF670-09D5-4D0B-BEBY-D96A2A528000', - ], - 'TaskId' => [ - 'description' => 'Task ID, which is returned when you create a refresh or preheat task.', - 'type' => 'string', - 'example' => '15940956620', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ET5BF670-09D5-4D0B-BEBY-D96A2A528000'], + 'TaskId' => ['description' => 'The task ID. This ID is returned when you create a refresh or prefetch task.', 'type' => 'string', 'example' => '15940956620', 'title' => ''], ], 'example' => '', ], @@ -75723,98 +42571,33 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingTimeParameter', - 'errorMessage' => 'The StartTime and EndTime must be both specified.', - 'description' => 'Please provide both a start time and an end time.', - ], - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], - [ - 'errorCode' => 'DomainNameOverLimit', - 'errorMessage' => 'A maximum of 500 domains are supported for each request.', - 'description' => 'Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.', - ], - [ - 'errorCode' => 'InvalidTime', - 'errorMessage' => 'The query time cannot exceed the last 3 days.', - 'description' => 'The query time cannot exceed the last 3 days.', - ], - [ - 'errorCode' => 'MissingParameter.ObjectType', - 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', - 'description' => 'Specify the ObjectType parameter.', - ], - [ - 'errorCode' => 'InvalidStationParameter', - 'errorMessage' => 'The specified Station is invalid.', - 'description' => 'The specified node parameter is invalid.', - ], - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests.Please try again later.', - 'description' => 'Requests are too frequent, please try again later.', - ], - [ - 'errorCode' => 'InvalidTaskId.Malformed', - 'errorMessage' => 'The specified taskId is invalid.', - 'description' => 'The specified task ID is invalid.', - ], - [ - 'errorCode' => 'InvalidParameters.InvalidUrls', - 'errorMessage' => 'The specified urls are invalid.', - 'description' => 'The requested URL parameter is invalid.', - ], - [ - 'errorCode' => 'QuotaExceeded', - 'errorMessage' => 'You attempts have exceeded the daily limit.', - 'description' => 'Exceeding the same day quota limit. The number of submissions today has been exhausted. You can query the number of times a quota can be used today through the quota API.', - ], - [ - 'errorCode' => 'InvalidParameter.RecordNotBelongToSite', - 'errorMessage' => 'The record name passed in does not belong to the current site.', - 'description' => 'The record name passed in does not belong to the current site.', - ], + ['errorCode' => 'MissingTimeParameter', 'errorMessage' => 'The StartTime and EndTime must be both specified.', 'description' => 'Please provide both a start time and an end time.'], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'DomainNameOverLimit', 'errorMessage' => 'A maximum of 500 domains are supported for each request.', 'description' => 'Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.'], + ['errorCode' => 'InvalidTime', 'errorMessage' => 'The query time cannot exceed the last 3 days.', 'description' => 'The query time cannot exceed the last 3 days.'], + ['errorCode' => 'MissingParameter.ObjectType', 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', 'description' => 'Specify the ObjectType parameter.'], + ['errorCode' => 'InvalidStationParameter', 'errorMessage' => 'The specified Station is invalid.', 'description' => 'The specified node parameter is invalid.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], + ['errorCode' => 'InvalidTaskId.Malformed', 'errorMessage' => 'The specified taskId is invalid.', 'description' => 'The specified task ID is invalid.'], + ['errorCode' => 'InvalidParameters.InvalidUrls', 'errorMessage' => 'The specified urls are invalid.', 'description' => 'The requested URL parameter is invalid.'], + ['errorCode' => 'QuotaExceeded', 'errorMessage' => 'You attempts have exceeded the daily limit.', 'description' => 'Exceeding the same day quota limit. The number of submissions today has been exhausted. You can query the number of times a quota can be used today through the quota API.'], + ['errorCode' => 'InvalidParameter.RecordNotBelongToSite', 'errorMessage' => 'The record name passed in does not belong to the current site.', 'description' => 'The record name passed in does not belong to the current site.'], ], 429 => [ - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'System load fluctuates, please try again later.', - 'description' => 'System load fluctuates, please try again later.', - ], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'System load fluctuates, please try again later.', 'description' => 'System load fluctuates, please try again later.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ET5BF670-09D5-4D0B-BEBY-D96A2A528000\\",\\n \\"TaskId\\": \\"15940956620\\"\\n}","type":"json"}]', - 'title' => 'PurgeCaches', + 'title' => 'Refresh node cache', 'changeSet' => [ - [ - 'createdAt' => '2025-03-13T07:58:30.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2025-02-10T01:55:17.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-12-06T02:11:35.000Z', - 'description' => 'Error codes changed, Request parameters changed', - ], - [ - 'createdAt' => '2024-10-15T01:58:27.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-03-13T07:58:30.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2025-02-10T01:55:17.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-06T02:11:35.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2024-10-15T01:58:27.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'PurgeCaches', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PurgeCaches'], ], ], 'ramActions' => [ @@ -75825,135 +42608,72 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], ], 'PutKv' => [ - 'summary' => 'Configures a key-value pair for a namespace. The request body can be up to 2 MB.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Creates or updates a single key-value pair in a namespace. The maximum size of a request is 2 MB.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238811', - 'abilityTreeNodes' => [ - 'FEATUREdcdnGMYWU5', - ], + 'abilityTreeNodes' => ['FEATUREdcdnGMYWU5'], ], 'parameters' => [ [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the namespace that you specify when you call the [CreateKvNamespace](~~2850317~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_namespace', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the namespace. You specify this name when you call the [CreateKvNamespace](~~2850317~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'test_namespace', 'title' => ''], ], [ 'name' => 'Key', 'in' => 'query', - 'schema' => [ - 'description' => 'The key name. The name can be up to 512 characters in length and cannot contain spaces or backslashes (\\\\).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_key', - 'title' => '', - ], + 'schema' => ['description' => 'The key can be up to 512 bytes long and cannot contain spaces or forward slashes (/).', 'type' => 'string', 'required' => true, 'example' => 'test_key', 'title' => ''], ], [ 'name' => 'Value', 'in' => 'formData', - 'schema' => [ - 'description' => 'The content of the key, which can be up to 2 MB (2 × 1000 × 1000). If the content is larger than 2 MB, call [PutKvWithHighCapacity](~~2850486~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_value', - 'title' => '', - ], + 'schema' => ['description' => 'The value to associate with the key. The maximum size is 2 MB (2,000,000 bytes). For values that exceed this limit, use the [PutKvWithHighCapacity](~~2850486~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'test_value', 'title' => ''], ], [ 'name' => 'Expiration', 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the key-value pair expires, which cannot be earlier than the current time. The value is a timestamp in seconds. If you specify both Expiration and ExpirationTtl, only ExpirationTtl takes effect.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1690081381', - 'title' => '', - ], + 'schema' => ['description' => 'The expiration time for the key-value pair, as a Unix timestamp in seconds. This value cannot be earlier than the current time. If you specify both Expiration and ExpirationTtl, ExpirationTtl takes precedence.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1690081381', 'title' => ''], ], [ 'name' => 'ExpirationTtl', 'in' => 'query', - 'schema' => [ - 'description' => 'The relative expiration time. Unit: seconds. If you specify both Expiration and ExpirationTtl, only ExpirationTtl takes effect.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3600', - 'title' => '', - ], + 'schema' => ['description' => 'The time-to-live (TTL) for the key-value pair, in seconds. If you specify both Expiration and ExpirationTtl, ExpirationTtl takes precedence.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3600', 'title' => ''], ], [ 'name' => 'Base64', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the content of the key is Base64-encoded. Set this parameter to true if you want to store the key content in binary format. When this parameter is set to true, the Value parameter must be Base64-encoded.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], + 'schema' => ['description' => 'Indicates whether the Value parameter uses Base64 encoding. Set this to true when storing a binary value. If this parameter is true, Value must be a valid Base64-encoded string.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', - ], - 'Length' => [ - 'description' => 'The length of the value in the key-value pair.'."\n", - 'type' => 'string', - 'example' => '4', - 'title' => '', - ], - 'Value' => [ - 'description' => 'The content of the key. If the content has more than 256 characters in length, the system displays the first 100 and the last 100 characters, and omits the middle part.'."\n", - 'type' => 'string', - 'example' => 'test', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'], + 'Length' => ['description' => 'The length of the value in the key-value pair.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'Value' => ['description' => 'The value of the key-value pair. If the value is longer than 256 characters, the response includes only the first 100 and last 100 characters.', 'type' => 'string', 'example' => 'test', 'title' => ''], ], 'example' => '', ], @@ -75961,115 +42681,44 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidAccount.Malformed', - 'errorMessage' => 'The specified account is invalid.', - 'description' => 'The account number is not entered correctly, for example, the input is empty.', - ], - [ - 'errorCode' => 'InvalidNameSpace.Malformed', - 'errorMessage' => 'The specified namespace is invalid.', - 'description' => 'The bucket name is entered incorrectly, such as an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.Malformed', - 'errorMessage' => 'The specified key is invalid.', - 'description' => 'Key name input error, such as entering an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.ExceedsMaximum', - 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', - 'description' => 'The length of the requested key is too large.', - ], - [ - 'errorCode' => 'InvalidValue.ExceedsMaximum', - 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', - 'description' => 'The value deposited is too large.', - ], + ['errorCode' => 'InvalidAccount.Malformed', 'errorMessage' => 'The specified account is invalid.', 'description' => 'The account number is not entered correctly, for example, the input is empty.'], + ['errorCode' => 'InvalidNameSpace.Malformed', 'errorMessage' => 'The specified namespace is invalid.', 'description' => 'The bucket name is entered incorrectly, such as an empty string.'], + ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified key is invalid.', 'description' => 'Key name input error, such as entering an empty string.'], + ['errorCode' => 'InvalidKey.ExceedsMaximum', 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', 'description' => 'The length of the requested key is too large.'], + ['errorCode' => 'InvalidValue.ExceedsMaximum', 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', 'description' => 'The value deposited is too large.'], ], 403 => [ - [ - 'errorCode' => 'InvalidKey.ExceedsCapacity', - 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', - 'description' => 'The capacity of the storage space exceeds the limit.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidParameters', - 'errorMessage' => 'The specified authentication parameters are invalid.', - 'description' => 'Authentication parameter input error.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'InvalidKey.ExceedsCapacity', 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', 'description' => 'The capacity of the storage space exceeds the limit.'], + ['errorCode' => 'Unauthorized.InvalidParameters', 'errorMessage' => 'The specified authentication parameters are invalid.', 'description' => 'Authentication parameter input error.'], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'InvalidAccount.NotFound', - 'errorMessage' => 'The specified account does not exist.', - 'description' => 'The specified account does not exist.', - ], - [ - 'errorCode' => 'InvalidNameSpace.NotFound', - 'errorMessage' => 'The specified namespace does not exist.', - 'description' => '', - ], - [ - 'errorCode' => 'InvalidKey.NotFound', - 'errorMessage' => 'The specified key does not exist.', - 'description' => 'The specified key-value pair does not exist.', - ], + ['errorCode' => 'InvalidAccount.NotFound', 'errorMessage' => 'The specified account does not exist.', 'description' => 'The specified account does not exist.'], + ['errorCode' => 'InvalidNameSpace.NotFound', 'errorMessage' => 'The specified namespace does not exist.', 'description' => ''], + ['errorCode' => 'InvalidKey.NotFound', 'errorMessage' => 'The specified key does not exist.', 'description' => 'The specified key-value pair does not exist.'], ], 406 => [ - [ - 'errorCode' => 'InvalidNameSpace.Duplicate', - 'errorMessage' => 'The specified namespace already exists.', - 'description' => 'Specified storage space', - ], - [ - 'errorCode' => 'InvalidNameSpace.QuotaFull', - 'errorMessage' => 'The maximum number of namespaces is exceeded.', - 'description' => 'The number of storage spaces exceeds the capacity limit.', - ], + ['errorCode' => 'InvalidNameSpace.Duplicate', 'errorMessage' => 'The specified namespace already exists.', 'description' => 'Specified storage space'], + ['errorCode' => 'InvalidNameSpace.QuotaFull', 'errorMessage' => 'The maximum number of namespaces is exceeded.', 'description' => 'The number of storage spaces exceeds the capacity limit.'], ], 429 => [ - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests are submitted.', - 'description' => 'Submissions are too frequent, please try again later', - ], - [ - 'errorCode' => 'TooQuickRequests', - 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', - 'description' => 'The modification or deletion of key-value pairs is too frequent.', - ], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests are submitted.', 'description' => 'Submissions are too frequent, please try again later'], + ['errorCode' => 'TooQuickRequests', 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', 'description' => 'The modification or deletion of key-value pairs is too frequent.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\",\\n \\"Length\\": \\"4\\",\\n \\"Value\\": \\"test\\"\\n}","type":"json"}]', 'title' => 'PutKv', 'changeSet' => [ - [ - 'createdAt' => '2024-09-20T13:49:27.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-20T13:49:27.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '50', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'PutKv', - ], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutKv'], ], ], 'ramActions' => [ @@ -76080,106 +42729,64 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'operationType' => 'write', - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\",\\n \\"Length\\": \\"4\\",\\n \\"Value\\": \\"test\\"\\n}","type":"json"}]', ], 'PutKvWithHighCapacity' => [ - 'summary' => 'Configures a large key-value pair for a namespace. The request body can be up to 25 MB.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Sets a single large-capacity key-value pair in a KV namespace. The maximum value size is 25 MB.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238726', - 'abilityTreeNodes' => [ - 'FEATUREdcdnGMYWU5', - ], + 'abilityTreeNodes' => ['FEATUREdcdnGMYWU5'], ], 'parameters' => [ [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the namespace that you specify when you call the [CreateKvNamespace](~~2850317~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_namesapce', - ], + 'schema' => ['description' => 'The name specified when you called the [CreateKvNamespace](~~2850317~~) operation.', 'type' => 'string', 'title' => '', 'required' => true, 'example' => 'test_namesapce'], ], [ 'name' => 'Key', 'in' => 'query', - 'schema' => [ - 'description' => 'The key name. The name can be up to 512 characters in length and cannot contain spaces or backslashes (\\\\).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_key', - 'title' => '', - ], + 'schema' => ['description' => 'The key name to set. The key name can be up to 512 characters in length and cannot contain spaces or backslashes (/).', 'type' => 'string', 'required' => true, 'example' => 'test_key', 'title' => ''], ], [ 'name' => 'Url', 'in' => 'query', - 'schema' => [ - 'description' => 'The download URL of the key-value pair that you want to upload. This parameter is automatically filled in when you use the SDK to call the operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7', - 'isFileTransferUrl' => true, - 'title' => '', - ], + 'schema' => ['description' => 'A publicly accessible HTTP or HTTPS URL that points to a JSON file containing the key-value pair to set. The server actively downloads the content from this URL.'."\n" + ."\n" + .'- If you use an SDK, the SDK automatically uploads the file and generates the URL.'."\n" + ."\n" + .'- In non-SDK scenarios, upload the JSON payload to any publicly accessible HTTP service and specify the URL.'."\n" + ."\n" + .'The file content pointed to by the URL must be in the following JSON format: {"Namespace":"","Key":"","Value":""}.', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'https://xxxobject.oss-cn-region.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F', - ], - 'Length' => [ - 'description' => 'The length of the value in the key-value pair.'."\n", - 'type' => 'string', - 'example' => '4', - 'title' => '', - ], - 'Value' => [ - 'description' => 'The content of the key. If the content has more than 256 characters in length, the system displays the first 100 and the last 100 characters, and omits the middle part.'."\n", - 'type' => 'string', - 'example' => 'test', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'], + 'Length' => ['description' => 'The length of the value in the key-value pair.', 'type' => 'string', 'example' => '4', 'title' => ''], + 'Value' => ['description' => 'The content of the key. If the content exceeds 256 characters, the first 100 and last 100 characters are returned with the middle portion omitted.', 'type' => 'string', 'example' => 'test', 'title' => ''], ], 'example' => '', ], @@ -76187,190 +42794,93 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidAccount.Malformed', - 'errorMessage' => 'The specified account is invalid.', - 'description' => 'The account number is not entered correctly, for example, the input is empty.', - ], - [ - 'errorCode' => 'InvalidNameSpace.Malformed', - 'errorMessage' => 'The specified namespace is invalid.', - 'description' => 'The bucket name is entered incorrectly, such as an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.Malformed', - 'errorMessage' => 'The specified key is invalid.', - 'description' => 'Key name input error, such as entering an empty string.', - ], - [ - 'errorCode' => 'InvalidKey.ExceedsMaximum', - 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', - 'description' => 'The length of the requested key is too large.', - ], - [ - 'errorCode' => 'InvalidValue.ExceedsMaximum', - 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', - 'description' => 'The value deposited is too large.', - ], + ['errorCode' => 'InvalidAccount.Malformed', 'errorMessage' => 'The specified account is invalid.', 'description' => 'The account number is not entered correctly, for example, the input is empty.'], + ['errorCode' => 'InvalidNameSpace.Malformed', 'errorMessage' => 'The specified namespace is invalid.', 'description' => 'The bucket name is entered incorrectly, such as an empty string.'], + ['errorCode' => 'InvalidKey.Malformed', 'errorMessage' => 'The specified key is invalid.', 'description' => 'Key name input error, such as entering an empty string.'], + ['errorCode' => 'InvalidKey.ExceedsMaximum', 'errorMessage' => 'The size of the key cannot exceed 512 bytes.', 'description' => 'The length of the requested key is too large.'], + ['errorCode' => 'InvalidValue.ExceedsMaximum', 'errorMessage' => 'The size of the value cannot exceed 2,000,000 bytes.', 'description' => 'The value deposited is too large.'], ], 403 => [ - [ - 'errorCode' => 'InvalidKey.ExceedsCapacity', - 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', - 'description' => 'The capacity of the storage space exceeds the limit.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidParameters', - 'errorMessage' => 'The specified authentication parameters are invalid.', - 'description' => 'Authentication parameter input error.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'InvalidKey.ExceedsCapacity', 'errorMessage' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', 'description' => 'The capacity of the storage space exceeds the limit.'], + ['errorCode' => 'Unauthorized.InvalidParameters', 'errorMessage' => 'The specified authentication parameters are invalid.', 'description' => 'Authentication parameter input error.'], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'InvalidAccount.NotFound', - 'errorMessage' => 'The specified account does not exist.', - 'description' => 'The specified account does not exist.', - ], - [ - 'errorCode' => 'InvalidNameSpace.NotFound', - 'errorMessage' => 'The specified namespace does not exist.', - 'description' => '', - ], - [ - 'errorCode' => 'InvalidKey.NotFound', - 'errorMessage' => 'The specified key does not exist.', - 'description' => 'The specified key-value pair does not exist.', - ], + ['errorCode' => 'InvalidAccount.NotFound', 'errorMessage' => 'The specified account does not exist.', 'description' => 'The specified account does not exist.'], + ['errorCode' => 'InvalidNameSpace.NotFound', 'errorMessage' => 'The specified namespace does not exist.', 'description' => ''], + ['errorCode' => 'InvalidKey.NotFound', 'errorMessage' => 'The specified key does not exist.', 'description' => 'The specified key-value pair does not exist.'], ], 406 => [ - [ - 'errorCode' => 'InvalidNameSpace.Duplicate', - 'errorMessage' => 'The specified namespace already exists.', - 'description' => 'Specified storage space', - ], - [ - 'errorCode' => 'InvalidNameSpace.QuotaFull', - 'errorMessage' => 'The maximum number of namespaces is exceeded.', - 'description' => 'The number of storage spaces exceeds the capacity limit.', - ], + ['errorCode' => 'InvalidNameSpace.Duplicate', 'errorMessage' => 'The specified namespace already exists.', 'description' => 'Specified storage space'], + ['errorCode' => 'InvalidNameSpace.QuotaFull', 'errorMessage' => 'The maximum number of namespaces is exceeded.', 'description' => 'The number of storage spaces exceeds the capacity limit.'], ], 429 => [ - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests are submitted.', - 'description' => 'Submissions are too frequent, please try again later', - ], - [ - 'errorCode' => 'TooQuickRequests', - 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', - 'description' => 'The modification or deletion of key-value pairs is too frequent.', - ], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests are submitted.', 'description' => 'Submissions are too frequent, please try again later'], + ['errorCode' => 'TooQuickRequests', 'errorMessage' => 'Request for putting or deleting keys are frequently submitted.', 'description' => 'The modification or deletion of key-value pairs is too frequent.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\",\\n \\"Length\\": \\"4\\",\\n \\"Value\\": \\"test\\"\\n}","type":"json"}]', - 'title' => 'PutKvWithHighCapacity', - 'description' => 'This operation allows you to upload a larger request body than by using [PutKv](~~PutKv~~). For small request bodies, we recommend that you use [PutKv](~~PutKv~~) to minimize the server processing time. This operation must be called by using SDKs. The following sample code uses the Golang SDK and PutKvWithHighCapacityAdvance to call the operation.'."\n" - ."\n" - .' func TestPutKvWithHighCapacity() {'."\n" - .' // Initialize the configurations.'."\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" + 'title' => 'Set a single large-capacity key-value pair in a KV namespace', + 'description' => 'This operation provides the same functionality as [PutKv](~~PutKv~~), but allows you to upload a larger request body. If the request body is small, use the [PutKv](~~PutKv~~) operation to reduce server-side processing time. This operation must be called by using an SDK. For example, when you use the Golang SDK, call the PutKvWithHighCapacityAdvance function.'."\n" + .'```'."\n" + .'func TestPutKvWithHighCapacity() {'."\n" + .' // Configuration initialization'."\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" - .' // Construct a request for uploading key-value pairs.'."\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" + .' // Construct the key-value pair request to upload'."\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" - .' // If the payload is greater than 2 MB, call the PutKvWithHighCapacity operation for upload.'."\n" - .' reqHighCapacity := &PutKvWithHighCapacityAdvanceRequest{'."\n" - .' Namespace: &namespace,'."\n" - .' Key: &key,'."\n" - .' UrlObject: bytes.NewReader([]byte(payload)),'."\n" - .' }'."\n" + .' // If the payload is larger than 2 MB, call the high-capacity operation to upload it'."\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" - .' }'."\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' => 'Error codes changed', - ], + ['createdAt' => '2024-09-20T13:49:26.000Z', 'description' => 'Error codes changed'], ], '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], + ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PutKvWithHighCapacity'], ], ], - 'operationType' => 'write', - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], + 'ramActions' => [], ], 'RebuildEdgeContainerAppStagingEnv' => [ - 'summary' => 'Rebuilds the staging environment for containerized applications.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Rebuild the staging environment of an edge container application.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -76383,36 +42893,26 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238564', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'app-88068867578379****', - 'title' => '', - ], + 'schema' => ['description' => 'The application ID. You can call the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation to obtain the application ID.'."\n" + .'>This parameter is required. If this parameter is not specified, the API returns InvalidParameter.appid (400). You can call ListEdgeContainerApps to obtain a valid application ID.'."\n" + .'Dependency chain: CreateEdgeContainerApp (if not created) → CreateEdgeContainerAppVersion → PublishEdgeContainerAppVersion (environment=staging) → RebuildEdgeContainerAppStagingEnv'."\n" + .'', 'type' => 'string', 'required' => false, 'example' => 'app-88068867578379****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-3C82-72F8FD6DA2FE'], ], 'example' => '', ], @@ -76420,35 +42920,17 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], + ['errorCode' => 'InvalidParameter.appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], ], 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], @@ -76458,180 +42940,156 @@ '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RebuildEdgeContainerAppStagingEnv'], ], ], + 'ramActions' => [], ], - 'ResetScheduledPreloadJob' => [ - 'summary' => 'Resets the progress of a scheduled prefetch task and starts the prefetch from the beginning.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ReleaseInstance' => [ + 'summary' => 'Schedules the release of a security instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '239114', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4TTNAL', - ], + 'abilityTreeCode' => '238733', + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the scheduled prefetch task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '665d3af3621bccf3fe29e1a4'."\n", + 'schema' => ['description' => 'The ID of the security instance. This must be a DDoS security instance ID in the format of esa-ddos-*. You can call the ListDDoSInstances operation to obtain the ID. Site instance IDs in the format of esa-site-* are not supported.', 'type' => 'string', 'required' => true, 'example' => 'esa-ddos-2sdj**3s'."\n", 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-****-A1D7-6C044FE73368'], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'CheckOrderFailed', 'errorMessage' => 'Invalid order parameter.', 'description' => 'Invalid order parameter.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.'], + ['errorCode' => 'InvalidSiteName', 'errorMessage' => 'Invalid website name. Check and try again.', 'description' => 'Invalid website name. Check and try again.'], + ['errorCode' => 'SYSTEM.NoSpecificCodeFailed', 'errorMessage' => 'Invalid subscription duration. Check and try again.', 'description' => 'Invalid subscription duration. Check and try again.'], + ['errorCode' => 'CheckPlanFailed', 'errorMessage' => 'Invalid plan name or code. Check and try again.', 'description' => 'Invalid plan name or code. Check and try again.'], + ['errorCode' => 'SubSiteUnavailable', 'errorMessage' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.', 'description' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.'], + ['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account balance is insufficient.', 'description' => 'Your account is in arrears, please pay the arrears before purchasing.'], + ['errorCode' => 'InsufficientBalance', 'errorMessage' => 'Your account balance is insufficient.', 'description' => 'Your account balance is insufficient, please recharge before purchasing.'], + ['errorCode' => 'InvalidComponent', 'errorMessage' => 'The order parameters is invalid.', 'description' => 'The order parameters is invalid.'], + ['errorCode' => 'RamAuthFailed', 'errorMessage' => 'The sub-account has no operation permission.', 'description' => ''], + ['errorCode' => 'Instance.ReleaseFailed', 'errorMessage' => 'Instance release failed.', 'description' => 'Instance release failed.'], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.', 'description' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.'], + ], + ], + 'title' => 'Schedule release', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '6', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseInstance'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'esa:ReleaseInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-****-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ResetScheduledPreloadJob' => [ + 'summary' => 'Resets the progress of a scheduled prefetch task and restarts the prefetch from the beginning.'."\n" + .'Before calling this operation, you must first create a scheduled prefetch task by calling CreateScheduledPreloadJob to obtain a valid task ID, and then pass the ID to this operation for resetting.', + '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' => 'The ID of the scheduled prefetch task.'."\n" + .'>The ID of the scheduled prefetch task. This parameter is required. You can obtain the ID from the response of CreateScheduledPreloadJob after creating a task, or query the ID of an existing task by calling GetScheduledPreloadJob or ListScheduledPreloadJobs.>.', 'type' => 'string', 'required' => false, 'example' => '665d3af3621bccf3fe29e1a4'."\n", 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - ], - 'AliUid' => [ - 'title' => '', - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => '15685865xxx14622', - ], - 'CreatedAt' => [ - 'title' => '', - 'description' => 'The time when the SQL task was created.'."\n", - 'type' => 'string', - 'example' => '2024-06-02T02:23:26Z', - ], - 'Domains' => [ - 'title' => '', - 'description' => 'The domain names to be prefetched.'."\n", - 'type' => 'string', - 'example' => 'testurl.com', - ], - 'ErrorInfo' => [ - 'title' => '', - 'description' => 'The error message that is returned.'."\n", - 'type' => 'string', - 'example' => 'invalid domain:test.com', - ], - 'FailedFileOss' => [ - 'title' => '', - 'description' => 'The URL of the OSS object that stores a list of URLs that failed the conditional check for prefetching.'."\n", - 'type' => 'string', - 'example' => 'https://xxxobject.oss-cn-reginon.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7', - ], - 'FileId' => [ - 'title' => '', - 'description' => 'The ID of the URL list file, which can be used during downloads.'."\n", - 'type' => 'string', - 'example' => '665d3b48621bccf3fe29e1a7', - ], - 'Id' => [ - 'title' => '', - 'description' => 'The ID of the prefetch task.'."\n", - 'type' => 'string', - 'example' => '665d3af3621bccf3fe29e1a4', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74'], + 'AliUid' => ['title' => '', 'description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '15685865xxx14622'], + 'CreatedAt' => ['title' => '', 'description' => 'The time when the task was created, in ISO 8601 format (for example, 2024-01-01T00:00:00+Z).', 'type' => 'string', 'example' => '2024-06-02T02:23:26Z'], + 'Domains' => ['title' => '', 'description' => 'The list of domain names to prefetch.', 'type' => 'string', 'example' => 'testurl.com'], + 'ErrorInfo' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'invalid domain:test.com'], + 'FailedFileOss' => ['title' => '', 'description' => 'The OSS URL of the failed file.', 'type' => 'string', 'example' => 'https://xxxobject.oss-cn-region.aliyuncs.com/9d91_xxxxxxxxxxx_158bb6e0f97c477791209bb46bd599f7'], + 'FileId' => ['title' => '', 'description' => 'The ID of the URL list file, which is used for downloading.', 'type' => 'string', 'example' => '665d3b48621bccf3fe29e1a7'], + 'Id' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => '665d3af3621bccf3fe29e1a4'], 'InsertWay' => [ 'title' => '', - 'description' => 'The method to submit the URLs to be prefetched.'."\n", + 'description' => 'The URL insertion method. Valid values:'."\n" + .'- oss: URLs are imported in batches from an OSS file.'."\n" + .'- testBox: URLs are entered one by one in a text box.', + 'enumValueTitles' => ['oss' => 'URLs are imported in batches from an OSS file.', 'testBox' => 'URLs are entered one by one in a text box.'], 'type' => 'string', + 'enum' => ['file', 'url'], 'example' => 'oss', - 'enum' => [ - 'file', - 'url', - ], - ], - 'Name' => [ - 'title' => '', - 'description' => 'The delivery project name.'."\n", - 'type' => 'string', - 'example' => 'example', - ], - 'SiteId' => [ - 'title' => '', - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '190007158391808', - ], - 'TaskSubmitted' => [ - 'title' => '', - 'description' => 'The number of submitted prefetch tasks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', ], + 'Name' => ['title' => '', 'description' => 'The task name.', 'type' => 'string', 'example' => 'example'], + 'SiteId' => ['title' => '', 'description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '190007158391808'], + 'TaskSubmitted' => ['title' => '', 'description' => 'The number of URLs that have been submitted to the system for prefetching.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'TaskType' => [ 'title' => '', - 'description' => 'The task type. Valid values: refresh and preload.'."\n", + 'description' => 'The task type (refresh or prefetch). Valid values:'."\n" + .'- path: directory refresh.'."\n" + .'- refresh: URL refresh.'."\n" + .'- preload: URL prefetch.', + 'enumValueTitles' => ['path' => 'Directory refresh.', 'refresh' => 'URL refresh.', 'preload' => 'URL prefetch.'], 'type' => 'string', + 'enum' => ['preload', 'refresh', 'path'], 'example' => 'preload', - 'enum' => [ - 'preload', - 'refresh', - 'path', - ], - ], - 'UrlCount' => [ - 'title' => '', - 'description' => 'The total number of URLs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'UrlSubmitted' => [ - 'title' => '', - 'description' => 'The number of submitted URLs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', ], + 'UrlCount' => ['title' => '', 'description' => 'The total number of URLs.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'UrlSubmitted' => ['title' => '', 'description' => 'The number of submitted URLs.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], 'example' => '', ], @@ -76639,76 +43097,33 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], - [ - 'errorCode' => 'InvalidJob.JobCountOfSiteFull', - 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', - 'description' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', - ], - [ - 'errorCode' => 'InvalidParameter.ObjectId', - 'errorMessage' => 'Invalid task ID or execution plan ID.', - 'description' => 'Invalid task ID or execution plan ID.', - ], - [ - 'errorCode' => 'MissingOssUrl', - 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', - 'description' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', - ], - [ - 'errorCode' => 'MissingUrlList', - 'errorMessage' => 'Enter the URLs you want to prefetch.', - 'description' => 'Enter the URLs you want to prefetch.', - ], - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests.Please try again later.', - 'description' => 'Requests are too frequent, please try again later.', - ], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'InvalidJob.JobCountOfSiteFull', 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', 'description' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.'], + ['errorCode' => 'InvalidParameter.ObjectId', 'errorMessage' => 'Invalid task ID or execution plan ID.', 'description' => 'Invalid task ID or execution plan ID.'], + ['errorCode' => 'MissingOssUrl', 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', 'description' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.'], + ['errorCode' => 'MissingUrlList', 'errorMessage' => 'Enter the URLs you want to prefetch.', 'description' => 'Enter the URLs you want to prefetch.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], ], 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' => '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.', - ], + ['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' => '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.'], ], [ - [ - 'errorCode' => 'InvalidJob.NotFound', - 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', - 'description' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', - ], - [ - 'errorCode' => 'LogNotFound', - 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', - 'description' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', - ], - [ - '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' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.', - ], + ['errorCode' => 'InvalidJob.NotFound', 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', 'description' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.'], + ['errorCode' => 'LogNotFound', 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', 'description' => 'Failed to query the log. Check whether the task ID and execution ID are valid.'], + ['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' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - '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"}]', - 'title' => 'ResetScheduledPreloadJob', + '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-region.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"}]', + 'title' => 'Reset the progress of a scheduled prefetch task', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'ResetScheduledPreloadJob', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetScheduledPreloadJob'], ], ], 'ramActions' => [ @@ -76719,29 +43134,16 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], ], 'RevokeClientCertificate' => [ 'summary' => 'Revokes an activated client certificate.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -76754,33 +43156,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239109', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'baba39055622c008b90285a8838ed09a', - 'title' => '', - ], + 'schema' => ['description' => 'The certificate ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'baba39055622c008b90285a8838ed09a', 'title' => ''], ], ], 'responses' => [ @@ -76790,31 +43177,10 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567890123', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com'."\n", - 'title' => '', - ], - 'Id' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'example' => 'baba39055622c008b90285a8838ed09a', - 'title' => '', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A123425345', - 'title' => '', - ], + 'SiteId' => ['description' => 'The website ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''], + 'SiteName' => ['description' => 'The website name.'."\n", 'type' => 'string', 'example' => 'example.com'."\n", 'title' => ''], + 'Id' => ['description' => 'The certificate ID.'."\n", 'type' => 'string', 'example' => 'baba39055622c008b90285a8838ed09a', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A123425345', 'title' => ''], ], 'example' => '', ], @@ -76822,61 +43188,26 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Certificate.StatusError', - 'errorMessage' => 'The status of the certificate is invalid.', - 'description' => 'The specified certificate status is invalid.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'Id.MissingParameter', - 'errorMessage' => 'The parameter Id is required.', - 'description' => 'The required parameter Id is missing.', - ], + ['errorCode' => 'Certificate.StatusError', 'errorMessage' => 'The status of the certificate is invalid.', 'description' => 'The specified certificate status is invalid.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Id.MissingParameter', 'errorMessage' => 'The parameter Id is required.', 'description' => 'The required parameter Id is missing.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'Certificate.NotFound', - 'errorMessage' => 'The specified certificate does not exist.', - 'description' => 'The specified certificate does not exist.', - ], + ['errorCode' => 'Certificate.NotFound', 'errorMessage' => 'The specified certificate does not exist.', 'description' => 'The specified certificate does not exist.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 1234567890123,\\n \\"SiteName\\": \\"example.com\\\\n\\",\\n \\"Id\\": \\"baba39055622c008b90285a8838ed09a\\",\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A123425345\\"\\n}","type":"json"}]', 'title' => 'RevokeClientCertificate', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'RevokeClientCertificate', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeClientCertificate'], ], ], 'ramActions' => [ @@ -76887,12 +43218,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -76903,13 +43229,8 @@ ], ], 'RollbackEdgeContainerAppVersion' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -76921,71 +43242,33 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239284', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'app-88068867578379****', - 'maxLength' => 64, - 'minLength' => 20, - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 20, 'title' => '', 'example' => 'app-88068867578379****'], ], [ 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The ID of version that you want to roll back.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ver-87962637161651****', - 'maxLength' => 64, - 'minLength' => 20, - ], + 'schema' => ['description' => 'The ID of the version to roll back to.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 20, 'title' => '', 'example' => 'ver-87962637161651****'], ], [ 'name' => 'Remarks', 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => 'The remarks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test rollback app', - 'maxLength' => 1024, - ], + 'schema' => ['description' => 'Additional information about the rollback.', 'type' => 'string', 'required' => false, 'maxLength' => 1024, 'title' => '', 'example' => 'test rollback app'], ], [ 'name' => 'UsedPercent', 'in' => 'query', - 'schema' => [ - 'description' => 'Indicates whether to use percentage-based rollback.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to use percentage rollback.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'Percentage', 'in' => 'query', - 'schema' => [ - 'description' => 'The adjusted publish percentage. Valid values: **1–100**. Default value: **0**.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - 'title' => '', - ], + 'schema' => ['description' => 'The deployment percentage for the target version after the rollback. Valid values: **1 to 100**. Default value: **0**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], ], ], 'responses' => [ @@ -76993,12 +43276,7 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E', 'title' => ''], ], 'description' => '', 'title' => '', @@ -77008,58 +43286,26 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application 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' => 'The VersionId parameter 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.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InvalidParameter.appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application 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' => 'The VersionId parameter 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.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], 'title' => 'Roll Back Edge Container Application', - 'summary' => 'Roll back a specific version of an edge container application. You can use this API to quickly revert an abnormal version and minimize losses.', + 'summary' => 'Rolls back an edge container application to a specified version. Use this API to quickly recover from a failed deployment and minimize service disruption.', 'changeSet' => [ - [ - 'createdAt' => '2025-04-08T08:08:06.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-04-08T08:08:06.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'RollbackEdgeContainerAppVersion', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RollbackEdgeContainerAppVersion'], ], ], 'ramActions' => [ @@ -77070,173 +43316,247 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C370DAF1-C838-4288-A1A0-9A87633D248E\\"\\n}","type":"json"}]', ], - 'SetCertificate' => [ - 'summary' => 'Used to configure whether to enable the certificate feature for a site and update certificate information. ', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SetAutomaticFrequencyControlConfig' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '239628', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeCode' => '253996', + 'abilityTreeNodes' => ['FEATUREdcdnUTRW1O'], ], 'parameters' => [ [ 'name' => 'SiteId', - 'in' => 'formData', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the site. Call the [ListSites](~~2850189~~) operation to obtain this ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], + ], + [ + 'name' => 'SiteVersion', + 'in' => 'query', + 'schema' => ['description' => 'The version of the site. For a site with version management enabled, this parameter specifies the version to which the configuration applies. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Enable', + 'in' => 'query', 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'Specifies whether to enable automatic frequency control. Valid values:'."\n" + ."\n" + .'- **on**: Enables automatic frequency control.'."\n" + ."\n" + .'- **off**: Disables automatic frequency control.', + 'type' => 'string', 'required' => true, - 'example' => '1234567890123', + 'enum' => ['on', 'off'], + 'example' => 'on', 'title' => '', ], ], [ - 'name' => 'Name', - 'in' => 'formData', + 'name' => 'Level', + 'in' => 'query', 'schema' => [ - 'description' => 'The certificate name.'."\n", + 'description' => 'The protection level. Valid values:'."\n" + ."\n" + .'- **loose**: Loose protection.'."\n" + ."\n" + .'- **normal**: Normal protection.'."\n" + ."\n" + .'- **strict**: Strict protection.', 'type' => 'string', - 'required' => false, - 'example' => 'yourCertName', - 'maxLength' => 128, + 'required' => true, + 'enum' => ['loose', 'normal', 'strict'], + 'example' => 'normal', 'title' => '', ], ], [ - 'name' => 'CasId', - 'in' => 'formData', + 'name' => 'ActionType', + 'in' => 'query', 'schema' => [ - 'description' => 'The certificate ID on Certificate Management Service.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '30000478'."\n", + 'description' => 'The action to take on requests that trigger the control. Valid values:'."\n" + ."\n" + .'- **observe**: Monitors the requests.'."\n" + ."\n" + .'- **deny**: Blocks the requests.'."\n" + ."\n" + .'- **js**: Issues a JS challenge.', + 'type' => 'string', + 'required' => true, + 'enum' => ['observe', 'deny', 'js'], + 'example' => 'js', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'F32C57AA-7BF8-49AE-A2CC-9F42390F5A19'], + 'Enable' => ['description' => 'Indicates whether automatic frequency control is enabled. Valid values:'."\n" + ."\n" + .'- **on**: Enabled.'."\n" + ."\n" + .'- **off**: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Level' => ['description' => 'The protection level. Valid values:'."\n" + ."\n" + .'- **loose**: Loose protection.'."\n" + ."\n" + .'- **normal**: Normal protection.'."\n" + ."\n" + .'- **strict**: Strict protection.', 'type' => 'string', 'example' => 'normal', 'title' => ''], + 'ActionType' => ['description' => 'The action taken on requests that trigger the control. Valid values:'."\n" + ."\n" + .'- **observe**: Requests are monitored.'."\n" + ."\n" + .'- **deny**: Requests are blocked.'."\n" + ."\n" + .'- **js**: JS challenges are issued.', 'type' => 'string', 'example' => 'js', 'title' => ''], + ], 'title' => '', + 'description' => 'The response parameters.', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'SetAutomaticFrequencyControlConfig', + 'summary' => 'Configures the automatic frequency control threshold for a site.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:SetAutomaticFrequencyControlConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F32C57AA-7BF8-49AE-A2CC-9F42390F5A19\\",\\n \\"Enable\\": \\"on\\",\\n \\"Level\\": \\"normal\\",\\n \\"ActionType\\": \\"js\\"\\n}","type":"json"}]', + ], + 'SetCertificate' => [ + 'summary' => 'Configures whether to enable the certificate feature for a site and updates certificate information.', + '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' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The certificate name. This parameter is required when Type is set to upload.', 'type' => 'string', 'required' => false, 'maxLength' => 128, 'example' => 'yourCertName', 'title' => ''], + ], + [ + 'name' => 'CasId', + 'in' => 'formData', + 'schema' => ['description' => 'The cloud certificate ID. This parameter is required when Type is set to cas.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30000478'."\n", 'title' => ''], + ], [ 'name' => 'Type', 'in' => 'formData', 'schema' => [ 'description' => 'The certificate type. Valid values:'."\n" ."\n" - .'* cas: a certificate purchased by using Certificate Management Service.'."\n" - .'* upload: a custom certificate that you upload.'."\n", + .'- **cas**: certificate from SSL Certificates Service.'."\n" + ."\n" + .'- **upload**: custom uploaded certificate.'."\n" + ."\n" + .'- **keyless**: keyless certificate.', + 'enumValueTitles' => ['cas' => 'Certificate from SSL Certificates Service.', 'upload' => 'Custom uploaded certificate.', 'keyless' => 'Keyless certificate.'], 'type' => 'string', 'required' => true, + 'enum' => ['cas', 'upload', 'keyless'], 'example' => 'cas', - 'enum' => [ - 'cas', - 'upload', - 'keyless', - ], 'title' => '', ], ], [ 'name' => 'Certificate', 'in' => 'formData', - 'schema' => [ - 'description' => 'The certificate content.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '-----BEGIN CERTIFICATE-----', - 'title' => '', - ], + 'schema' => ['description' => 'The certificate content. This parameter is required when Type is set to upload.', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN CERTIFICATE-----', 'title' => ''], ], [ 'name' => 'PrivateKey', 'in' => 'formData', - 'schema' => [ - 'description' => 'The private key of the certificate.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '-----BEGIN PRIVATE KEY-----', - 'title' => '', - ], + 'schema' => ['description' => 'The certificate private key. This parameter is required when Type is set to upload.', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN PRIVATE KEY-----', 'title' => ''], ], [ 'name' => 'Region', 'in' => 'formData', - 'schema' => [ - 'description' => 'The region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - 'title' => '', - ], + 'schema' => ['description' => 'The region. This parameter is required when Type is set to cas. Valid values:'."\n" + ."\n" + .'- China site accounts: cn-hangzhou.'."\n" + ."\n" + .'- International site accounts: ap-southeast-1.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => 'The certificate ID on ESA.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'babae7c40fef412d887688b91c9e****', - 'title' => '', - ], + 'schema' => ['description' => 'The certificate ID. Certificates of the free type (created by calling the ApplyCertificate operation) are not supported. Certificates of the cas and upload types are supported.', 'type' => 'string', 'required' => false, 'example' => 'babae7c40fef412d887688b91c9e****', 'title' => ''], ], [ 'name' => 'KeyServerId', 'in' => 'query', - 'schema' => [ - 'description' => 'Keyless server ID. This parameter is valid only when Type is keyless. ', - 'type' => 'string', - 'required' => false, - 'example' => '1233112****', - 'title' => '', - ], + 'schema' => ['description' => 'The keyless server ID. This parameter takes effect only when Type is set to keyless.', 'type' => 'string', 'required' => false, 'example' => '1233112****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A666D44F-19D6-490E-97CF-1A64AB962C57', - ], - 'Id' => [ - 'type' => 'string', - 'description' => 'The certificate ID.'."\n", - 'example' => 'babae7c40fef412d887688b91c9e****', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A666D44F-19D6-490E-97CF-1A64AB962C57'], + 'Id' => ['description' => 'The certificate ID.', 'type' => 'string', 'example' => 'babae7c40fef412d887688b91c9e****', 'title' => ''], ], 'example' => '', ], @@ -77244,129 +43564,40 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Certificate.StatusError', - 'errorMessage' => 'The status of the certificate is invalid.', - 'description' => 'The specified certificate status is invalid.', - ], - [ - 'errorCode' => 'Certificate.Duplicated', - 'errorMessage' => 'The certificate name already exists.', - 'description' => 'The certificate is duplicated.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidCertificate.NotFound', - 'errorMessage' => 'The specified certificate does not match the website. Check the validity of the certificate and try again.', - 'description' => 'The specified certificate does not match the website. Check the validity of the certificate and try again.', - ], - [ - 'errorCode' => 'InvalidSSLPub', - 'errorMessage' => 'The specified Certificate is invalid.', - 'description' => 'The value specified for the Certificate parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidSSLPri', - 'errorMessage' => 'The specified PrivateKey is invalid.', - 'description' => 'The value specified for the PrivateKey parameter is invalid.', - ], - [ - 'errorCode' => 'CasId.MissingParameter', - 'errorMessage' => 'The CasId parameter is required.', - 'description' => 'The CasId parameter is missing.', - ], - [ - 'errorCode' => 'PrivateKey.MissingParameter', - 'errorMessage' => 'The PrivateKey parameter is required.', - 'description' => 'Missing PrivateKey parameter.', - ], - [ - 'errorCode' => 'Certificate.MissingParameter', - 'errorMessage' => 'The Certificate parameter is required.', - 'description' => 'Missing Certificate parameter.', - ], - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'UpdateFreeCertificate.NotSupport', - 'errorMessage' => 'The free certificate does not support the update operation.', - 'description' => 'The free certificate does not support the update operation.', - ], - [ - 'errorCode' => 'CertificateDomainNotMatchSite', - 'errorMessage' => 'The domain name in the specified certificate does not match the site.', - 'description' => 'The domain name in the certificate does not match the current site.', - ], - [ - 'errorCode' => 'CertificateNotMatchPrivateKey', - 'errorMessage' => 'The specified certificate does not match the private key.', - 'description' => 'The specified certificate and private key do not match.', - ], - [ - 'errorCode' => 'CertQuotaCheckFailed', - 'errorMessage' => 'The custom certificate quota verification failed. The number of uploaded certificates exceeds the upper limit allowed for the plan.', - 'description' => 'The custom certificate quota verification failed. The number of uploaded certificates exceeds the upper limit allowed for the plan.', - ], + ['errorCode' => 'Certificate.StatusError', 'errorMessage' => 'The status of the certificate is invalid.', 'description' => 'The specified certificate status is invalid.'], + ['errorCode' => 'Certificate.Duplicated', 'errorMessage' => 'The certificate name already exists.', 'description' => 'The certificate is duplicated.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InvalidCertificate.NotFound', 'errorMessage' => 'The specified certificate does not match the website. Check the validity of the certificate and try again.', 'description' => 'The specified certificate does not match the website. Check the validity of the certificate and try again.'], + ['errorCode' => 'InvalidSSLPub', 'errorMessage' => 'The specified Certificate is invalid.', 'description' => 'The value specified for the Certificate parameter is invalid.'], + ['errorCode' => 'InvalidSSLPri', 'errorMessage' => 'The specified PrivateKey is invalid.', 'description' => 'The value specified for the PrivateKey parameter is invalid.'], + ['errorCode' => 'CasId.MissingParameter', 'errorMessage' => 'The CasId parameter is required.', 'description' => 'The CasId parameter is missing.'], + ['errorCode' => 'PrivateKey.MissingParameter', 'errorMessage' => 'The PrivateKey parameter is required.', 'description' => 'Missing PrivateKey parameter.'], + ['errorCode' => 'Certificate.MissingParameter', 'errorMessage' => 'The Certificate parameter is required.', 'description' => 'Missing Certificate parameter.'], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'UpdateFreeCertificate.NotSupport', 'errorMessage' => 'The free certificate does not support the update operation.', 'description' => 'The free certificate does not support the update operation.'], + ['errorCode' => 'CertificateDomainNotMatchSite', 'errorMessage' => 'The domain name in the specified certificate does not match the site.', 'description' => 'The domain name in the certificate does not match the current site.'], + ['errorCode' => 'CertificateNotMatchPrivateKey', 'errorMessage' => 'The specified certificate does not match the private key.', 'description' => 'The specified certificate and private key do not match.'], + ['errorCode' => 'CertQuotaCheckFailed', 'errorMessage' => 'The custom certificate quota verification failed. The number of uploaded certificates exceeds the upper limit allowed for the plan.', 'description' => 'The custom certificate quota verification failed. The number of uploaded certificates exceeds the upper limit allowed for the plan.'], ], 404 => [ - [ - 'errorCode' => 'Certificate.NotFound', - 'errorMessage' => 'The specified certificate does not exist.', - 'description' => 'The specified certificate does not exist.', - ], + ['errorCode' => 'Certificate.NotFound', 'errorMessage' => 'The specified certificate does not exist.', 'description' => 'The specified certificate does not exist.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A666D44F-19D6-490E-97CF-1A64AB962C57\\",\\n \\"Id\\": \\"babae7c40fef412d887688b91c9e****\\"\\n}","type":"json"}]', - 'title' => 'Configure Site Certificate ', + 'title' => 'Configure site certificate', 'changeSet' => [ - [ - 'createdAt' => '2025-02-13T01:37:33.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2025-01-09T05:44:49.000Z', - 'description' => 'Response parameters changed', - ], - [ - 'createdAt' => '2024-10-15T03:45:00.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-10-03T13:48:40.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T09:53:46.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-06T06:59:01.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-02-13T01:37:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-09T05:44:49.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-10-15T03:45:00.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-10-03T13:48:40.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T09:53:46.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-06T06:59:01.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'SetCertificate', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetCertificate'], ], ], 'ramActions' => [ @@ -77377,26 +43608,15 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'translator' => 'machine', ], - 'SetClientCertificateHostnames' => [ - 'summary' => 'Attach a domain name to the specified client CA certificate. If no certificate is specified, the domain name is attached to the ESA CA certificate.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'SetClientCaCertificateHostnames' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -77409,37 +43629,112 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239185', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', + 'schema' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], + ], + [ + 'name' => 'Hostnames', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'type' => 'array', + 'items' => ['description' => 'A hostname.', 'type' => 'string', 'required' => false, 'example' => 'www.example.com ', 'title' => ''], 'required' => true, - 'example' => '123456789****', + 'description' => 'A list of hostnames.', + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The client CA certificate ID.', 'type' => 'string', 'required' => false, 'example' => 'babaabcd****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SiteId' => ['description' => 'The site ID. You can obtain the ID by calling the [ListSites](~~ListSites~~) API.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456****', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'Id' => ['description' => 'The client CA certificate ID.', 'type' => 'string', 'example' => 'babaabcd****', 'title' => ''], + 'Hostnames' => [ + 'type' => 'array', + 'items' => ['description' => 'A hostname.', 'type' => 'string', 'example' => 'www.example.com', 'title' => ''], + 'description' => 'A list of bound hostnames.', + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', 'title' => ''], + ], 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'QuotaCheckFailed.Function', 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', 'description' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.'], + ], + 403 => [ + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], + ], + [ + ['errorCode' => 'Certificate.NotFound', 'errorMessage' => 'The specified certificate does not exist.', 'description' => 'The specified certificate does not exist.'], + ], + ], + 'title' => 'SetClientCaCertificateHostnames', + 'summary' => 'Binds hostnames to a specified client CA certificate. If you do not specify a certificate, the hostnames are bound to the ESA CA certificate.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SiteId\\": 0,\\n \\"SiteName\\": \\"example.com\\",\\n \\"Id\\": \\"babaabcd****\\",\\n \\"Hostnames\\": [\\n \\"www.example.com\\"\\n ],\\n \\"RequestId\\": \\"34DCBC8A-****-****-****-6DAA11D7DDBD\\"\\n}","type":"json"}]', + ], + 'SetClientCertificateHostnames' => [ + 'summary' => 'Associates domain names with a specified client CA certificate. If no certificate is specified, the domain names are associated with the ESA CA certificate. This API is deprecated. Use SetClientCaCertificateHostnames instead.', + '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' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], + ], [ 'name' => 'Hostnames', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The domain names to associate.'."\n", + 'description' => 'The list of domain names to associate.', 'type' => 'array', - 'items' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.example.com', - 'title' => '', - ], + 'items' => ['description' => 'The domain name.', 'type' => 'string', 'required' => false, 'example' => 'www.example.com', 'title' => ''], 'required' => true, 'title' => '', 'example' => '', @@ -77448,59 +43743,27 @@ [ 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the client CA certificate.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'babab9db65ee5efcca9f3d41d4b50d**', - 'title' => '', - ], + 'schema' => ['description' => 'The client CA certificate ID.', 'type' => 'string', 'required' => false, 'example' => 'babab9db65ee5efcca9f3d41d4b50d**', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456789****', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com ', - 'title' => '', - ], - 'Id' => [ - 'description' => 'The ID of the client CA certificate.'."\n", - 'type' => 'string', - 'example' => 'babab9db65ee5efcca9f3d41d4b50d**', - 'title' => '', - ], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789****', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com ', 'title' => ''], + 'Id' => ['description' => 'The client CA certificate ID.', 'type' => 'string', 'example' => 'babab9db65ee5efcca9f3d41d4b50d**', 'title' => ''], 'Hostnames' => [ - 'description' => 'List of attached domain names.', + 'description' => 'The list of domain names to associate.', 'type' => 'array', - 'items' => [ - 'description' => 'Domain name.', - 'type' => 'string', - 'example' => 'www.example.com', - 'title' => '', - ], + 'items' => ['description' => 'The domain name.', 'type' => 'string', 'example' => 'www.example.com', 'title' => ''], 'title' => '', 'example' => '', ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ET5BF670-09D5-4D0B-BEBY-D96A2A528000', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ET5BF670-09D5-4D0B-BEBY-D96A2A528000', 'title' => ''], ], 'example' => '', ], @@ -77508,62 +43771,28 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.Function', - 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', - 'description' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', - ], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'QuotaCheckFailed.Function', 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', 'description' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], [ - [ - 'errorCode' => 'Certificate.NotFound', - 'errorMessage' => 'The specified certificate does not exist.', - 'description' => 'The specified certificate does not exist.', - ], + ['errorCode' => 'Certificate.NotFound', 'errorMessage' => 'The specified certificate does not exist.', 'description' => 'The specified certificate does not exist.'], ], ], - 'title' => 'Set domain name binding for client certificate', + '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"}]', + 'title' => 'Set client CA certificate hostname bindings', + 'requestParamsDescription' => 'The Id parameter value must be the `Id` field value of each certificate record in the ListClientCaCertificates response, or the `CACertificateId` field value of each certificate record in the ListClientCertificates response, not the `Id` field. When associating domain names with an ESA CA certificate, you do not need to specify the certificate Id.', 'changeSet' => [ - [ - 'createdAt' => '2025-03-13T09:10:44.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-03-13T09:10:44.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'SetClientCertificateHostnames', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetClientCertificateHostnames'], ], ], 'ramActions' => [ @@ -77574,26 +43803,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => 'Sets the maximum burstable protection bandwidth for a DDoS instance in mainland China.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -77606,33 +43825,19 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '254004', - 'abilityTreeNodes' => [ - 'FEATUREdcdn5DYCZJ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn5DYCZJ'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The ID of the instance. You can call the [ListUserRatePlanInstances](~~2852398~~) operation to obtain the instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'esa-site-ads11w', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the instance. You can call the [ListUserRatePlanInstances](~~2852398~~) operation to obtain the instance ID.', 'type' => 'string', 'required' => true, 'example' => 'esa-site-ads11w', 'title' => ''], ], [ 'name' => 'MaxBurstGbps', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum burstable protection bandwidth for the DDoS instance in mainland China. The unit is Gbps.', - 'type' => 'string', - 'required' => true, - 'example' => '300', - 'title' => '', - ], + 'schema' => ['description' => 'The maximum burstable protection bandwidth for the DDoS instance in mainland China. The unit is Gbps.', 'type' => 'string', 'required' => true, 'example' => '300', 'title' => ''], ], ], 'responses' => [ @@ -77640,12 +43845,7 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request. Alibaba Cloud generates this unique ID for each request. Use the ID to troubleshoot issues.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - 'title' => '', - ], + 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates this unique ID for each request. Use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', 'title' => ''], ], 'description' => '', 'title' => '', @@ -77655,66 +43855,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => '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.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - '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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - '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' => '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.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => '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.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['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' => '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.'], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'SetDdosMaxBurstGbps', 'changeSet' => [], 'flowControl' => [ @@ -77724,15 +43878,9 @@ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\"\\n}","type":"json"}]', ], 'SetHttpDDoSAttackIntelligentProtection' => [ - 'summary' => 'Configures smart HTTP DDoS protection.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'This operation configures the intelligent HTTP DDoS protection settings for a site.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -77745,39 +43893,27 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239326', - 'abilityTreeNodes' => [ - 'FEATUREdcdnO1ZP9O', - ], + 'abilityTreeNodes' => ['FEATUREdcdnO1ZP9O'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '1', - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the site. You can obtain the site ID by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '123456****', 'title' => ''], ], [ 'name' => 'AiMode', 'in' => 'query', 'schema' => [ - 'description' => 'The mode of smart HTTP DDoS protection. Valid values:'."\n" + 'description' => 'The mode for the intelligent HTTP DDoS protection feature. Valid values:'."\n" ."\n" - .'* **observe**: alert.'."\n" - .'* **defense**: block.'."\n", + .'- **observe**: The system generates warnings for attack traffic but does not block it.'."\n" + ."\n" + .'- **defense**: The system blocks detected attack traffic.', 'type' => 'string', 'required' => true, + 'enum' => ['observe', 'defense'], 'example' => 'defense', - 'enum' => [ - 'observe', - 'defense', - ], 'title' => '', ], ], @@ -77785,21 +43921,19 @@ 'name' => 'AiTemplate', 'in' => 'query', 'schema' => [ - 'description' => 'The level of smart HTTP DDoS protection. Valid values:'."\n" + 'description' => 'The sensitivity level for the intelligent HTTP DDoS protection feature. Valid values:'."\n" + ."\n" + .'- **level0**: very loose'."\n" + ."\n" + .'- **level30**: loose'."\n" ."\n" - .'* **level0**: very loose.'."\n" - .'* **level30**: loose.'."\n" - .'* **level60**: normal.'."\n" - .'* **level90**: strict.'."\n", + .'- **level60**: normal'."\n" + ."\n" + .'- **level90**: strict', 'type' => 'string', 'required' => true, + 'enum' => ['level30', 'level60', 'level90', 'level0'], 'example' => 'level60', - 'enum' => [ - 'level30', - 'level60', - 'level90', - 'level0', - ], 'title' => '', ], ], @@ -77808,42 +43942,25 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792', - ], - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456****', - 'title' => '', - ], - 'AiMode' => [ - 'description' => 'The mode of smart HTTP DDoS protection. Valid values:'."\n" - ."\n" - .'* **observe**: alert.'."\n" - .'* **defense**: block.'."\n", - 'type' => 'string', - 'example' => 'defense', - 'title' => '', - ], - 'AiTemplate' => [ - 'description' => 'The level of smart HTTP DDoS protection. Valid values:'."\n" - ."\n" - .'* **level0**: very loose.'."\n" - .'* **level30**: loose.'."\n" - .'* **level60**: normal.'."\n" - .'* **level90**: strict.'."\n", - 'type' => 'string', - 'example' => 'level60', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792'], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456****', 'title' => ''], + 'AiMode' => ['description' => 'The protection mode for the intelligent HTTP DDoS protection feature. Valid values:'."\n" + ."\n" + .'- **observe**: The system generates warnings for attack traffic but does not block it.'."\n" + ."\n" + .'- **defense**: The system blocks detected attack traffic.', 'type' => 'string', 'example' => 'defense', 'title' => ''], + 'AiTemplate' => ['description' => 'The sensitivity level for the intelligent HTTP DDoS protection feature. Valid values:'."\n" + ."\n" + .'- **level0**: very loose'."\n" + ."\n" + .'- **level30**: loose'."\n" + ."\n" + .'- **level60**: normal'."\n" + ."\n" + .'- **level90**: strict', 'type' => 'string', 'example' => 'level60', 'title' => ''], ], 'example' => '', ], @@ -77851,50 +43968,25 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'ErrSiteIdNoteEnterprise', - 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', - 'description' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'ErrSiteIdNoteEnterprise', 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', 'description' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.'], ], 403 => [ - [ - 'errorCode' => 'SiteIdDDoSVersionCheckFailed', - 'errorMessage' => 'SiteId DDoS version check failed.', - 'description' => 'Failed to check the DDoS version corresponding to the site.', - ], + ['errorCode' => 'SiteIdDDoSVersionCheckFailed', 'errorMessage' => 'SiteId DDoS version check failed.', 'description' => 'Failed to check the DDoS version corresponding to the site.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + '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' => 'SetHttpDDoSAttackIntelligentProtection', 'changeSet' => [ - [ - 'createdAt' => '2024-11-19T03:35:34.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-11-19T03:35:34.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'SetHttpDDoSAttackIntelligentProtection', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetHttpDDoSAttackIntelligentProtection'], ], ], 'ramActions' => [ @@ -77905,28 +43997,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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 \\"AiMode\\": \\"defense\\",\\n \\"AiTemplate\\": \\"level60\\"\\n}","type":"json"}]', ], 'SetHttpDDoSAttackProtection' => [ 'summary' => 'Configures HTTP DDoS attack protection for a website.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -77939,23 +44019,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239030', - 'abilityTreeNodes' => [ - 'FEATUREdcdn5DYCZJ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn5DYCZJ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '1', - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '123456****', 'title' => ''], ], [ 'name' => 'GlobalMode', @@ -77970,12 +44040,7 @@ 'type' => 'string', 'required' => true, 'example' => 'default', - 'enum' => [ - 'weak', - 'default', - 'hard', - 'very weak', - ], + 'enum' => ['weak', 'default', 'hard', 'very weak'], 'title' => '', ], ], @@ -77987,25 +44052,9 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E', - ], - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456****', - 'title' => '', - ], - 'GlobalMode' => [ - 'description' => 'The level of HTTP DDoS attack protection.'."\n", - 'type' => 'string', - 'example' => 'default'."\n", - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D248E'], + 'SiteId' => ['description' => 'The website ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123456****', 'title' => ''], + 'GlobalMode' => ['description' => 'The level of HTTP DDoS attack protection.'."\n", 'type' => 'string', 'example' => 'default'."\n", 'title' => ''], ], 'example' => '', ], @@ -78013,51 +44062,25 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'ErrSiteIdNoteEnterprise', - 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', - 'description' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'ErrSiteIdNoteEnterprise', 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', 'description' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.'], ], 403 => [ - [ - 'errorCode' => 'SiteIdDDoSVersionCheckFailed', - 'errorMessage' => 'SiteId DDoS version check failed.', - 'description' => 'Failed to check the DDoS version corresponding to the site.', - ], + ['errorCode' => 'SiteIdDDoSVersionCheckFailed', 'errorMessage' => 'SiteId DDoS version check failed.', 'description' => 'Failed to check the DDoS version corresponding to the site.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C370DAF1-C838-4288-A1A0-9A87633D248E\\",\\n \\"SiteId\\": 0,\\n \\"GlobalMode\\": \\"default\\\\n\\"\\n}","type":"json"}]', 'title' => 'SetHttpDDoSAttackProtection', 'changeSet' => [ - [ - 'createdAt' => '2024-11-19T03:35:34.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-11-19T03:35:34.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'SetHttpDDoSAttackProtection', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetHttpDDoSAttackProtection'], ], ], 'ramActions' => [ @@ -78068,12 +44091,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -78081,13 +44099,8 @@ ], 'SetHttpDDoSAttackRuleAction' => [ 'summary' => 'Set the Protection Action for Specified HTTP DDoS Attack Rules', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -78100,37 +44113,20 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '263689', - 'abilityTreeNodes' => [ - 'FEATUREdcdn5DYCZJ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn5DYCZJ'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '1', - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '123456****', 'title' => ''], ], [ 'name' => 'RuleIds', 'in' => 'query', - 'schema' => [ - 'description' => 'List of rule IDs to be operated on, separated by English commas (,).'."\n" - .'> You can call the [DescribeHttpDDoSAttackRules](~~DescribeHttpDDoSAttackRules~~) API to get this parameter.', - 'type' => 'string', - 'required' => true, - 'minLength' => 1, - 'example' => '100000', - 'title' => '', - ], + 'schema' => ['description' => 'List of rule IDs to be operated on, separated by English commas (,).'."\n" + .'> You can call the [DescribeHttpDDoSAttackRules](~~DescribeHttpDDoSAttackRules~~) API to get this parameter.', 'type' => 'string', 'required' => true, 'minLength' => 1, 'example' => '100000', 'title' => ''], ], [ 'name' => 'RuleAction', @@ -78145,11 +44141,7 @@ .'- **observe**: Observe.', 'type' => 'string', 'required' => true, - 'enum' => [ - 'deny', - 'js', - 'observe', - ], + 'enum' => ['deny', 'js', 'observe'], 'example' => 'js', 'title' => '', ], @@ -78162,12 +44154,7 @@ 'description' => 'Response Schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID', - 'type' => 'string', - 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D2***', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => 'C370DAF1-C838-4288-A1A0-9A87633D2***'], ], 'example' => '', ], @@ -78175,30 +44162,14 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'The specified SiteId is invalid.', - 'description' => 'The specified SiteId is invalid.Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'ErrSiteIdNoteEnterprise', - 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', - 'description' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', - ], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'The specified SiteId is invalid.', 'description' => 'The specified SiteId is invalid.Check parameter SiteId and try again.'], + ['errorCode' => 'ErrSiteIdNoteEnterprise', 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', 'description' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.'], ], 403 => [ - [ - 'errorCode' => 'SiteIdDDoSVersionCheckFailed', - 'errorMessage' => 'SiteId DDoS version check failed.', - 'description' => 'Failed to check the DDoS version corresponding to the site.', - ], + ['errorCode' => 'SiteIdDDoSVersionCheckFailed', 'errorMessage' => 'SiteId DDoS version check failed.', 'description' => 'Failed to check the DDoS version corresponding to the site.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], 'title' => 'Set the Protection Action for Specified HTTP DDoS Attack Rules', @@ -78214,12 +44185,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -78228,13 +44194,8 @@ ], 'SetHttpDDoSAttackRuleStatus' => [ 'summary' => 'Set the Protection Status of Specified HTTP DDoS Attack Rules', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -78247,37 +44208,20 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '263688', - 'abilityTreeNodes' => [ - 'FEATUREdcdn5DYCZJ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn5DYCZJ'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '1', - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '123456****', 'title' => ''], ], [ 'name' => 'RuleIds', 'in' => 'query', - 'schema' => [ - 'description' => 'List of rule IDs to be operated on, separated by English commas (,).'."\n" - .'> You can call the [DescribeHttpDDoSAttackRules](~~DescribeHttpDDoSAttackRules~~) interface to get this parameter.', - 'type' => 'string', - 'required' => true, - 'minLength' => 1, - 'example' => '87570', - 'title' => '', - ], + 'schema' => ['description' => 'List of rule IDs to be operated on, separated by English commas (,).'."\n" + .'> You can call the [DescribeHttpDDoSAttackRules](~~DescribeHttpDDoSAttackRules~~) interface to get this parameter.', 'type' => 'string', 'required' => true, 'minLength' => 1, 'example' => '87570', 'title' => ''], ], [ 'name' => 'Status', @@ -78289,10 +44233,7 @@ .'- **off**: Disable.', 'type' => 'string', 'required' => true, - 'enum' => [ - 'on', - 'off', - ], + 'enum' => ['on', 'off'], 'example' => 'on', 'title' => '', ], @@ -78305,12 +44246,7 @@ 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request', - 'type' => 'string', - 'example' => 'F7B84CF8-F8A4-53F8-9B91-2643FD72042B', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'ID of the request', 'type' => 'string', 'example' => 'F7B84CF8-F8A4-53F8-9B91-2643FD72042B'], ], 'example' => '', ], @@ -78318,30 +44254,14 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'The specified SiteId is invalid.', - 'description' => 'The specified SiteId is invalid.Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'ErrSiteIdNoteEnterprise', - 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', - 'description' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', - ], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'The specified SiteId is invalid.', 'description' => 'The specified SiteId is invalid.Check parameter SiteId and try again.'], + ['errorCode' => 'ErrSiteIdNoteEnterprise', 'errorMessage' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', 'description' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.'], ], 403 => [ - [ - 'errorCode' => 'SiteIdDDoSVersionCheckFailed', - 'errorMessage' => 'SiteId DDoS version check failed.', - 'description' => 'Failed to check the DDoS version corresponding to the site.', - ], + ['errorCode' => 'SiteIdDDoSVersionCheckFailed', 'errorMessage' => 'SiteId DDoS version check failed.', 'description' => 'Failed to check the DDoS version corresponding to the site.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], 'title' => 'Set the Protection Status of Specified HTTP DDoS Attack Rules', @@ -78357,26 +44277,126 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => 'Attach domain names to the origin fetch client certificate at the domain name granularity.', - 'methods' => [ - 'post', + 'SetKeylessServer' => [ + 'summary' => 'Creates or updates a keyless server configuration.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239628', + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => ['description' => 'The site ID. You can obtain this ID by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], + ], + [ + 'name' => 'Host', + 'in' => 'formData', + 'schema' => ['description' => 'The hostname of the keyless server. The value can be a domain name or an IP address.', 'type' => 'string', 'required' => true, 'maxLength' => 128, 'example' => 'keyless.example.com', 'title' => ''], + ], + [ + 'name' => 'Port', + 'in' => 'formData', + 'schema' => ['description' => 'The keyless server port.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '443', 'title' => ''], + ], + [ + 'name' => 'Verify', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to verify the server certificate of the keyless server. Default: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'CaCertificate', + 'in' => 'formData', + 'schema' => ['description' => 'The CA certificate used to verify the server certificate of the keyless server. This parameter applies only when `Verify` is set to `true`.', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN CERTIFICATE-----****', 'title' => ''], + ], + [ + 'name' => 'ClientCertificate', + 'in' => 'formData', + 'schema' => ['description' => 'The client certificate. This parameter must be used with the `ClientPrivateKey` parameter.', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN CERTIFICATE-----****', 'title' => ''], + ], + [ + 'name' => 'ClientPrivateKey', + 'in' => 'formData', + 'schema' => ['description' => 'The client private key. This parameter must be used with the `ClientCertificate` parameter.', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN RSA PRIVATE KEY-----****', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The keyless server ID.', 'type' => 'string', 'required' => false, 'example' => 'baba39055622c008b90285a8838e****', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The keyless server name.', 'type' => 'string', 'required' => true, 'example' => 'example', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD'], + 'Id' => ['description' => 'The keyless server ID.', 'type' => 'string', 'example' => 'babaabcd****', 'title' => ''], + 'SiteId' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456****', 'title' => ''], + 'SiteName' => ['description' => 'The site name.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Certificate.Duplicated', 'errorMessage' => 'The certificate name already exists.', 'description' => 'The certificate is duplicated.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InvalidCertificate.NotFound', 'errorMessage' => 'The specified certificate does not match the website. Check the validity of the certificate and try again.', 'description' => 'The specified certificate does not match the website. Check the validity of the certificate and try again.'], + ['errorCode' => 'PrivateKey.MissingParameter', 'errorMessage' => 'The PrivateKey parameter is required.', 'description' => 'Missing PrivateKey parameter.'], + ['errorCode' => 'Certificate.MissingParameter', 'errorMessage' => 'The Certificate parameter is required.', 'description' => 'Missing Certificate parameter.'], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], + ['errorCode' => 'InvalidSSLPub', 'errorMessage' => 'The specified Certificate is invalid.', 'description' => 'The value specified for the Certificate parameter is invalid.'], + ['errorCode' => 'InvalidSSLPri', 'errorMessage' => 'The specified PrivateKey is invalid.', 'description' => 'The value specified for the PrivateKey parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'UpdateFreeCertificate.NotSupport', 'errorMessage' => 'The free certificate does not support the update operation.', 'description' => 'The free certificate does not support the update operation.'], + ['errorCode' => 'CertificateDomainNotMatchSite', 'errorMessage' => 'The domain name in the specified certificate does not match the site.', 'description' => 'The domain name in the certificate does not match the current site.'], + ['errorCode' => 'CertificateNotMatchPrivateKey', 'errorMessage' => 'The specified certificate does not match the private key.', 'description' => 'The specified certificate and private key do not match.'], + ['errorCode' => 'CertQuotaCheckFailed', 'errorMessage' => 'The custom certificate quota verification failed. The number of uploaded certificates exceeds the upper limit allowed for the plan.', 'description' => 'The custom certificate quota verification failed. The number of uploaded certificates exceeds the upper limit allowed for the plan.'], + ], + 404 => [ + ['errorCode' => 'Certificate.NotFound', 'errorMessage' => 'The specified certificate does not exist.', 'description' => 'The specified certificate does not exist.'], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'SetKeylessServer', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34DCBC8A-****-****-****-6DAA11D7DDBD\\",\\n \\"Id\\": \\"babaabcd****\\",\\n \\"SiteId\\": 0,\\n \\"SiteName\\": \\"example.com\\"\\n}","type":"json"}]', + ], + 'SetOriginClientCertificateHostnames' => [ + 'summary' => 'Associates specified hostnames with an origin client certificate.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -78389,49 +44409,28 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '261756', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the site.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'babaabcd****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the certificate.', 'type' => 'string', 'required' => true, 'example' => 'babaabcd****', 'title' => ''], ], [ 'name' => 'Hostnames', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The domain names to associate.'."\n", + 'description' => 'The hostnames to associate with the certificate.', 'type' => 'array', - 'items' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.example.com', - 'title' => '', - ], + 'items' => ['description' => 'A hostname.', 'type' => 'string', 'required' => false, 'example' => 'www.example.com', 'title' => ''], 'required' => true, 'title' => '', 'example' => '', @@ -78445,43 +44444,17 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - 'title' => '', - ], - 'Id' => [ - 'description' => 'The ID of the client certificate.', - 'type' => 'string', - 'example' => 'babaabcd****', - 'title' => '', - ], - 'SiteName' => [ - 'description' => 'The website name.'."\n", - 'type' => 'string', - 'example' => 'example.com', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', 'title' => ''], + 'Id' => ['description' => 'The ID of the certificate.', 'type' => 'string', 'example' => 'babaabcd****', 'title' => ''], + 'SiteName' => ['description' => 'The name of the site.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], 'Hostnames' => [ - 'description' => 'The domain name.'."\n", + 'description' => 'The hostnames associated with the certificate.', 'type' => 'array', - 'items' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'example' => 'www.example.com', - 'title' => '', - ], + 'items' => ['description' => 'A hostname in the list.', 'type' => 'string', 'example' => 'www.example.com', 'title' => ''], 'title' => '', 'example' => '', ], - 'SiteId' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'example' => '123456789****', - 'format' => 'int64', - 'title' => '', - ], + 'SiteId' => ['description' => 'The ID of the site.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789****', 'title' => ''], ], 'example' => '', ], @@ -78489,68 +44462,26 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.Function', - 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', - 'description' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'Id.MissingParameter', - 'errorMessage' => 'The parameter Id is required.', - 'description' => 'The required parameter Id is missing.', - ], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'QuotaCheckFailed.Function', 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', 'description' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'Id.MissingParameter', 'errorMessage' => 'The parameter Id is required.', 'description' => 'The required parameter Id is missing.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Attach domain names to the origin fetch client certificate at the domain name granularity.', 'changeSet' => [ - [ - 'createdAt' => '2025-03-31T09:21:09.000Z', - 'description' => 'Response parameters changed', - ], + ['createdAt' => '2025-03-31T09:21:09.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '20', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'SetOriginClientCertificateHostnames', - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetOriginClientCertificateHostnames'], ], ], 'ramActions' => [ @@ -78561,12 +44492,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -78574,13 +44500,9 @@ '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' => 'Starts a scheduled prefetch plan based on the plan ID.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Starts a scheduled prefetch based on the prefetch plan ID.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -78593,92 +44515,36 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239332', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4TTNAL', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4TTNAL'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the prefetch plan.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '665d3b48621bccf3fe29e1a7', - 'title' => '', - ], + 'schema' => ['description' => 'The prefetch plan ID.', 'type' => 'string', 'required' => true, 'example' => '665d3b48621bccf3fe29e1a7', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '65C66B7B-671A-8297-9187-2R5477247B76', - ], - 'Id' => [ - 'description' => 'The ID of the prefetch plan.'."\n", - 'type' => 'string', - 'example' => '665d3b48621bccf3fe29e1a7', - 'title' => '', - ], - 'StartTime' => [ - 'description' => 'The start time of the prefetch plan.'."\n", - 'type' => 'string', - 'example' => '2024-05-31T17:10:48.849+08:00', - 'title' => '', - ], - 'EndTime' => [ - 'description' => 'The end time of the prefetch plan.'."\n", - 'type' => 'string', - 'example' => '2024-05-31T18:10:48.849+08:00', - 'title' => '', - ], - 'Interval' => [ - 'description' => 'The time interval between each batch execution. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - 'title' => '', - ], - 'SliceLen' => [ - 'description' => 'The number of URLs prefetched in each batch.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the prefetch plan. Valid values:'."\n" - ."\n" - .'* **waiting**'."\n" - .'* **running**'."\n" - .'* **finished**'."\n" - .'* **failed**'."\n" - .'* **stopped**', - 'type' => 'string', - 'example' => 'waiting', - 'title' => '', - ], - 'JobId' => [ - 'description' => 'The ID of the prefetch task.'."\n", - 'type' => 'string', - 'example' => '665d3af3621bccf3fe29e1a4', - 'title' => '', - ], - 'AliUid' => [ - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => '15685865xxx14622', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '65C66B7B-671A-8297-9187-2R5477247B76'], + 'Id' => ['description' => 'The prefetch plan ID.', 'type' => 'string', 'example' => '665d3b48621bccf3fe29e1a7', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the scheduled prefetch plan, in ISO 8601 format (such as 2024-01-01T00:00:00+Z).', 'type' => 'string', 'example' => '2024-05-31T17:10:48.849+08:00', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the scheduled prefetch plan, in ISO 8601 format (such as 2024-01-01T00:00:00+Z).', 'type' => 'string', 'example' => '2024-05-31T18:10:48.849+08:00', 'title' => ''], + 'Interval' => ['description' => 'The execution interval between each batch of the scheduled prefetch plan, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'SliceLen' => ['description' => 'The number of URLs in each batch of the scheduled prefetch.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Status' => ['description' => 'The status of the scheduled prefetch plan. Valid values:'."\n" + .'- **waiting**: Waiting to be executed.'."\n" + .'- **running**: Being executed.'."\n" + .'- **finished**: Execution completed.'."\n" + .'- **failed**: Execution failed.'."\n" + .'- **stopped**: Execution paused.', 'type' => 'string', 'example' => 'waiting', 'title' => ''], + 'JobId' => ['description' => 'The prefetch task ID.', 'type' => 'string', 'example' => '665d3af3621bccf3fe29e1a4', 'title' => ''], + 'AliUid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '15685865xxx14622', 'title' => ''], ], 'example' => '', ], @@ -78686,109 +44552,42 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], - [ - 'errorCode' => 'InvalidJob.JobCountOfSiteFull', - 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', - 'description' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', - ], - [ - 'errorCode' => 'InvalidParameter.ObjectId', - 'errorMessage' => 'Invalid task ID or execution plan ID.', - 'description' => 'Invalid task ID or execution plan ID.', - ], - [ - 'errorCode' => 'MissingOssUrl', - 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', - 'description' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', - ], - [ - 'errorCode' => 'MissingUrlList', - 'errorMessage' => 'Enter the URLs you want to prefetch.', - 'description' => 'Enter the URLs you want to prefetch.', - ], - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests.Please try again later.', - 'description' => 'Requests are too frequent, please try again later.', - ], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'InvalidJob.JobCountOfSiteFull', 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', 'description' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.'], + ['errorCode' => 'InvalidParameter.ObjectId', 'errorMessage' => 'Invalid task ID or execution plan ID.', 'description' => 'Invalid task ID or execution plan ID.'], + ['errorCode' => 'MissingOssUrl', 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', 'description' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.'], + ['errorCode' => 'MissingUrlList', 'errorMessage' => 'Enter the URLs you want to prefetch.', 'description' => 'Enter the URLs you want to prefetch.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], ], 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' => '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.', - ], + ['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' => '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.'], ], [ - [ - 'errorCode' => 'InvalidJob.NotFound', - 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', - 'description' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', - ], - [ - 'errorCode' => 'LogNotFound', - 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', - 'description' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', - ], - [ - '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' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.', - ], + ['errorCode' => 'InvalidJob.NotFound', 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', 'description' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.'], + ['errorCode' => 'LogNotFound', 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', 'description' => 'Failed to query the log. Check whether the task ID and execution ID are valid.'], + ['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' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], '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"}]', - 'title' => 'StartScheduledPreloadExecution', + 'title' => 'Start a single scheduled prefetch plan', '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartScheduledPreloadExecution'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], + 'ramActions' => [], ], 'StopScheduledPreloadExecution' => [ - 'summary' => 'Stops a scheduled prefetch plan based on the plan ID.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Stops a single scheduled preload execution plan based on the preload plan ID.'."\n" + .'Prerequisites: (1) This API only takes effect when the execution plan status is running. Execution plans in the waiting or failed status cannot be stopped. (2) Whether an execution plan can reach the running status depends on whether the site it belongs to has completed access verification (site Status=active).', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -78801,92 +44600,36 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239019', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4TTNAL', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4TTNAL'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the prefetch plan.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '66599bd7397885b43804901c', - 'title' => '', - ], + 'schema' => ['description' => 'The preload plan ID, obtained from the SuccessExecutions[].Id field returned by CreateScheduledPreloadExecutions. Before calling this API, you must first create a preload task by calling CreateScheduledPreloadJob, and then create an execution plan by calling CreateScheduledPreloadExecutions.', 'type' => 'string', 'required' => true, 'example' => '66599bd7397885b43804901c', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', - ], - 'Id' => [ - 'description' => 'The ID of the prefetch plan.'."\n", - 'type' => 'string', - 'example' => '66599bd7397885b43804901c', - 'title' => '', - ], - 'StartTime' => [ - 'description' => 'The start time of the prefetch plan.'."\n", - 'type' => 'string', - 'example' => '2024-05-31T17:10:48.849+08:00', - 'title' => '', - ], - 'EndTime' => [ - 'description' => 'The end time of the prefetch plan.'."\n", - 'type' => 'string', - 'example' => '2024-05-31T18:10:48.849+08:00', - 'title' => '', - ], - 'Interval' => [ - 'description' => 'The time interval between each batch execution in the plan. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - 'title' => '', - ], - 'SliceLen' => [ - 'description' => 'The number of URLs prefetched in each batch.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the prefetch plan. Valid values:'."\n" - ."\n" - .'* **waiting**'."\n" - .'* **running**'."\n" - .'* **finished**'."\n" - .'* **failed**'."\n" - .'* **stopped**', - 'type' => 'string', - 'example' => 'stopped', - 'title' => '', - ], - 'JobId' => [ - 'description' => 'The ID of the prefetch task.'."\n", - 'type' => 'string', - 'example' => '665d3af3621bccf3fe29e1a4', - 'title' => '', - ], - 'AliUid' => [ - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => '15685865xxx14622', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'], + 'Id' => ['description' => 'The preload plan ID.', 'type' => 'string', 'example' => '66599bd7397885b43804901c', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the scheduled preload plan, in ISO 8601 format (e.g., 2024-01-01T00:00:00+Z).', 'type' => 'string', 'example' => '2024-05-31T17:10:48.849+08:00', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the scheduled preload plan, in ISO 8601 format (e.g., 2024-01-01T00:00:00+Z).', 'type' => 'string', 'example' => '2024-05-31T18:10:48.849+08:00', 'title' => ''], + 'Interval' => ['description' => 'The execution interval between batches in the scheduled preload plan, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'SliceLen' => ['description' => 'The number of URLs per batch in the scheduled preload.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Status' => ['description' => 'The status of the scheduled preload plan. Valid values:'."\n" + .'- **waiting**: Waiting to be executed.'."\n" + .'- **running**: Being executed.'."\n" + .'- **finished**: Execution completed.'."\n" + .'- **failed**: Execution failed.'."\n" + .'- **stopped**: Execution paused.', 'type' => 'string', 'example' => 'stopped', 'title' => ''], + 'JobId' => ['description' => 'The preload task ID.', 'type' => 'string', 'example' => '665d3af3621bccf3fe29e1a4', 'title' => ''], + 'AliUid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '15685865xxx14622', 'title' => ''], ], 'example' => '', ], @@ -78894,76 +44637,33 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], - [ - 'errorCode' => 'InvalidJob.JobCountOfSiteFull', - 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', - 'description' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', - ], - [ - 'errorCode' => 'InvalidParameter.ObjectId', - 'errorMessage' => 'Invalid task ID or execution plan ID.', - 'description' => 'Invalid task ID or execution plan ID.', - ], - [ - 'errorCode' => 'MissingOssUrl', - 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', - 'description' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', - ], - [ - 'errorCode' => 'MissingUrlList', - 'errorMessage' => 'Enter the URLs you want to prefetch.', - 'description' => 'Enter the URLs you want to prefetch.', - ], - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests.Please try again later.', - 'description' => 'Requests are too frequent, please try again later.', - ], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'InvalidJob.JobCountOfSiteFull', 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', 'description' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.'], + ['errorCode' => 'InvalidParameter.ObjectId', 'errorMessage' => 'Invalid task ID or execution plan ID.', 'description' => 'Invalid task ID or execution plan ID.'], + ['errorCode' => 'MissingOssUrl', 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', 'description' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.'], + ['errorCode' => 'MissingUrlList', 'errorMessage' => 'Enter the URLs you want to prefetch.', 'description' => 'Enter the URLs you want to prefetch.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], ], 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' => '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.', - ], + ['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' => '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.'], ], [ - [ - 'errorCode' => 'InvalidJob.NotFound', - 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', - 'description' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', - ], - [ - 'errorCode' => 'LogNotFound', - 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', - 'description' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', - ], - [ - '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' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.', - ], + ['errorCode' => 'InvalidJob.NotFound', 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', 'description' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.'], + ['errorCode' => 'LogNotFound', 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', 'description' => 'Failed to query the log. Check whether the task ID and execution ID are valid.'], + ['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' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], '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"}]', - 'title' => 'StopScheduledPreloadExecution', + 'title' => 'Stop a Single Scheduled Preload Execution Plan', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'StopScheduledPreloadExecution', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopScheduledPreloadExecution'], ], ], 'ramActions' => [ @@ -78974,31 +44674,94 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'SubmitUploadTask' => [ + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239230', + 'abilityTreeNodes' => ['FEATUREdcdnBCJPGN', 'FEATUREdcdnRELTJV', 'FEATUREdcdnEWYS3A', 'FEATUREdcdn4TTNAL'], + ], + 'parameters' => [ + [ + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => ['description' => 'The website ID. You can call the [ListSites](~~ListSites~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456789****', 'title' => ''], + ], + [ + 'name' => 'UploadId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the file upload task, which is generated when you call [UploadTask](~~UploadTask~~).'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1593805857882113', 'title' => ''], + ], + [ + 'name' => 'Force', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to refresh resources in the corresponding directory if the requested content is different from that on the origin server. Default value: false. This parameter takes effect for a purge task.'."\n" + ."\n" + .'* **true**: purges all resources in the directory.'."\n" + .'* **false**: refresh the changed resources in the directory.'."\n", 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9'], + 'UploadId' => ['description' => 'The ID of the file upload task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1593805857882113', 'title' => ''], ], + 'example' => '', ], ], ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'MissingTimeParameter', 'errorMessage' => 'The StartTime and EndTime must be both specified.', 'description' => 'Please provide both a start time and an end time.'], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'DomainNameOverLimit', 'errorMessage' => 'A maximum of 500 domains are supported for each request.', 'description' => 'Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.'], + ['errorCode' => 'InvalidTime', 'errorMessage' => 'The query time cannot exceed the last 3 days.', 'description' => 'The query time cannot exceed the last 3 days.'], + ['errorCode' => 'MissingParameter.ObjectType', 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', 'description' => 'Specify the ObjectType parameter.'], + ['errorCode' => 'InvalidStationParameter', 'errorMessage' => 'The specified Station is invalid.', 'description' => 'The specified node parameter is invalid.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], + ['errorCode' => 'InvalidTaskId.Malformed', 'errorMessage' => 'The specified taskId is invalid.', 'description' => 'The specified task ID is invalid.'], + ['errorCode' => 'InvalidParameters.InvalidUrls', 'errorMessage' => 'The specified urls are invalid.', 'description' => 'The requested URL parameter is invalid.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], + 'title' => 'SubmitUploadTask', + 'summary' => 'Submits a purge or prefetch task after a file that contains resources to be purged or prefetched is uploaded.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"UploadId\\": 1593805857882113\\n}","type":"json"}]', ], 'TagResources' => [ 'summary' => 'Adds one or more tags to resources.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -79011,25 +44774,17 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238938', - 'abilityTreeNodes' => [ - 'FEATUREdcdn6S5O3S', - ], + 'abilityTreeNodes' => ['FEATUREdcdn6S5O3S'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The region ID. Valid values:'."\n" - ."\n" - .'* China site (aliyun.com): cn-hangzhou'."\n" - .'* International site (alibabacloud.com): ap-southeast-1'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - 'title' => '', - ], + 'schema' => ['description' => 'The region ID. Valid values:'."\n" + ."\n" + .'* China site (aliyun.com): cn-hangzhou'."\n" + .'* International site (alibabacloud.com): ap-southeast-1'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ResourceId', @@ -79038,13 +44793,7 @@ 'schema' => [ 'description' => 'The resource ID. Enter a website ID or DNS record ID.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The resource ID. Enter a website ID or DNS record ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'items' => ['description' => 'The resource ID. Enter a website ID or DNS record ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], 'required' => true, 'maxItems' => 51, 'title' => '', @@ -79062,20 +44811,8 @@ 'description' => 'The tags that you want to add to the resource. You can enter up to 20 tags.'."\n", 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '', - 'description' => 'The tag keys.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env', - ], - 'Value' => [ - 'title' => '', - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'value', - ], + 'Key' => ['title' => '', 'description' => 'The tag keys.'."\n", 'type' => 'string', 'required' => true, 'example' => 'env'], + 'Value' => ['title' => '', 'description' => 'The tag value.'."\n", 'type' => 'string', 'required' => true, 'example' => 'value'], ], 'required' => false, 'title' => '', @@ -79091,16 +44828,10 @@ 'name' => 'ResourceType', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The type of the resource. Valid values:'."\n" - ."\n" - .'* Site: **site**'."\n" - .'* DNS records: **record**'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'site', - 'title' => '', - ], + 'schema' => ['description' => 'The type of the resource. Valid values:'."\n" + ."\n" + .'* Site: **site**'."\n" + .'* DNS records: **record**'."\n", 'type' => 'string', 'required' => true, 'example' => 'site', 'title' => ''], ], ], 'responses' => [ @@ -79108,12 +44839,7 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792', 'title' => ''], ], 'description' => '', 'title' => '', @@ -79123,16 +44849,8 @@ ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], - [ - 'errorCode' => 'Record.NotFound', - 'errorMessage' => 'The record does not exist. Check your configurations and try again.', - 'description' => 'The record does not exist. Check your configurations and try again.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], + ['errorCode' => 'Record.NotFound', 'errorMessage' => 'The record does not exist. Check your configurations and try again.', 'description' => 'The record does not exist. Check your configurations and try again.'], ], ], 'eventInfo' => [ @@ -79142,19 +44860,11 @@ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"156A6B-677B1A-4297B7-9187B7-2B44792\\"\\n}","type":"json"}]', 'title' => 'TagResources', 'changeSet' => [ - [ - 'createdAt' => '2025-08-21T07:40:23.000Z', - 'description' => 'Error codes changed, Request parameters changed', - ], + ['createdAt' => '2025-08-21T07:40:23.000Z', 'description' => 'Error codes changed, Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'TagResources', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'], ], ], 'ramActions' => [ @@ -79165,12 +44875,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -79178,14 +44883,8 @@ ], 'UntagResources' => [ 'summary' => 'Deletes a resource tag based on a specified resource ID.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -79198,22 +44897,14 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239579', - 'abilityTreeNodes' => [ - 'FEATUREdcdn6S5O3S', - ], + 'abilityTreeNodes' => ['FEATUREdcdn6S5O3S'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The ID of the region where the resources reside. Set the value to **cn-hangzhou**.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the region where the resources reside. Set the value to **cn-hangzhou**.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ResourceId', @@ -79222,13 +44913,7 @@ 'schema' => [ 'description' => 'The ID of resource N. Valid values of N: **1** to **50**.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The ID of resource N. Valid values of N: **1** to **50**.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'example.com', - 'title' => '', - ], + 'items' => ['description' => 'The ID of resource N. Valid values of N: **1** to **50**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'example.com', 'title' => ''], 'required' => true, 'maxItems' => 51, 'title' => '', @@ -79242,13 +44927,7 @@ 'schema' => [ 'description' => 'The key of tag N to remove from the resource. Valid values of N: **1** to **20**.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The key of tag N to remove from the resource. Valid values of N: **1** to **20**.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'env', - 'title' => '', - ], + 'items' => ['description' => 'The key of tag N to remove from the resource. Valid values of N: **1** to **20**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'env', 'title' => ''], 'required' => false, 'maxItems' => 21, 'title' => '', @@ -79259,30 +44938,18 @@ 'name' => 'ResourceType', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The resource type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'site', - 'title' => '', - ], + 'schema' => ['description' => 'The resource type.'."\n", 'type' => 'string', 'required' => true, 'example' => 'site', 'title' => ''], ], [ 'name' => 'All', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'Specifies whether to remove all tags. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n" - ."\n" - .'Default value: **false**.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to remove all tags. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n" + ."\n" + .'Default value: **false**.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -79290,12 +44957,7 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '85H66C7B-671A-4297-9187-2C4477247A74', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '85H66C7B-671A-4297-9187-2C4477247A74', 'title' => ''], ], 'description' => '', 'title' => '', @@ -79305,47 +44967,23 @@ ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'InvalidResourceId.NotFound', - 'errorMessage' => 'The specified resource does not exist or is released.', - 'description' => 'The resource does not exist or has been released.', - ], - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], - [ - 'errorCode' => 'Record.NotFound', - 'errorMessage' => 'The record does not exist. Modify it and try again.', - 'description' => 'The record does not exist. Modify it and try again.', - ], + ['errorCode' => 'InvalidResourceId.NotFound', 'errorMessage' => 'The specified resource does not exist or is released.', 'description' => 'The resource does not exist or has been released.'], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], + ['errorCode' => 'Record.NotFound', 'errorMessage' => 'The record does not exist. Modify it and try again.', 'description' => 'The record does not exist. Modify it and try again.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"85H66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', 'title' => 'UntagResources', 'changeSet' => [ - [ - 'createdAt' => '2025-08-21T07:40:23.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T06:13:40.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-08-21T07:40:23.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T06:13:40.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UntagResources', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'], ], ], 'ramActions' => [ @@ -79356,25 +44994,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => [ - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -79386,33 +45015,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '249938', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'esa-cr-9tuv*********', - 'title' => '', - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => false, 'example' => 'esa-cr-9tuv*********', 'title' => ''], ], [ 'name' => 'TargetQuotaGb', 'in' => 'query', - 'schema' => [ - 'description' => 'Cache requested size, in GB.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000', - 'title' => '', - ], + 'schema' => ['description' => 'Cache requested size, in GB.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', 'title' => ''], ], [ 'name' => 'ChargeType', @@ -79421,10 +45035,7 @@ 'description' => 'Billing type. Valid values:'."\n" .'- PREPAY'."\n" .'- POSTPAY', - 'enumValueTitles' => [ - 'PREPAY' => 'PREPAY', - 'POSTPAY' => 'POSTPAY', - ], + 'enumValueTitles' => ['PREPAY' => 'PREPAY', 'POSTPAY' => 'POSTPAY'], 'type' => 'string', 'required' => false, 'example' => 'PREPAY', @@ -79434,14 +45045,7 @@ [ 'name' => 'AutoPay', 'in' => 'query', - 'schema' => [ - 'description' => 'Automatic payment.', - 'type' => 'boolean', - 'default' => 'false', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], + 'schema' => ['description' => 'Automatic payment.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ @@ -79451,24 +45055,9 @@ 'description' => 'Response structure.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '40423A7F-A83D-1E24-B80E-86DD25790759'."\n", - ], - 'OrderId' => [ - 'description' => 'Order ID.', - 'type' => 'string', - 'example' => '2223332122***'."\n", - 'title' => '', - ], - 'InstanceId' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'example' => 'esa-cr-9tuv*********', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '40423A7F-A83D-1E24-B80E-86DD25790759'."\n"], + 'OrderId' => ['description' => 'Order ID.', 'type' => 'string', 'example' => '2223332122***'."\n", 'title' => ''], + 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'esa-cr-9tuv*********', 'title' => ''], ], 'example' => '', ], @@ -79476,82 +45065,27 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], - [ - 'errorCode' => 'CheckPlanFailed', - 'errorMessage' => 'Invalid plan name or code. Check and try again.', - 'description' => 'Invalid plan name or code. Check and try again.', - ], - [ - '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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.', - ], - [ - 'errorCode' => 'InvalidSiteName', - 'errorMessage' => 'Invalid website name. Check and try again.', - 'description' => 'Invalid website name. Check and try again.', - ], - [ - 'errorCode' => 'SYSTEM.NoSpecificCodeFailed', - 'errorMessage' => 'Invalid subscription duration. Check and try again.', - 'description' => 'Invalid subscription duration. Check and try again.', - ], - [ - 'errorCode' => 'Order.InstanceHasUnpaidOrder', - 'errorMessage' => 'You have an unpaid order. Complete the payment or cancel the order first.', - 'description' => 'You have an unpaid order. Complete the payment or cancel the order first.', - ], - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.', - 'description' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.', - ], - [ - 'errorCode' => 'InsufficientBalance', - 'errorMessage' => 'Your account balance is insufficient.', - 'description' => 'Your account balance is insufficient, please recharge before purchasing.', - ], - [ - 'errorCode' => 'InsufficientAvailableQuota', - 'errorMessage' => 'Your account balance is insufficient.', - 'description' => 'Your account is in arrears, please pay the arrears before purchasing.', - ], - [ - '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' => 'The configuration for the upgrade or downgrade is not changed.', - ], - [ - 'errorCode' => 'InvalidComponent', - 'errorMessage' => 'The order parameters is invalid.', - 'description' => 'The order parameters is invalid.', - ], - [ - 'errorCode' => 'RamAuthFailed', - 'errorMessage' => 'The sub-account has no operation permission.', - 'description' => '', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['errorCode' => 'CheckPlanFailed', 'errorMessage' => 'Invalid plan name or code. Check and try again.', 'description' => 'Invalid plan name or code. Check and try again.'], + ['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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.'], + ['errorCode' => 'InvalidSiteName', 'errorMessage' => 'Invalid website name. Check and try again.', 'description' => 'Invalid website name. Check and try again.'], + ['errorCode' => 'SYSTEM.NoSpecificCodeFailed', 'errorMessage' => 'Invalid subscription duration. Check and try again.', 'description' => 'Invalid subscription duration. Check and try again.'], + ['errorCode' => 'Order.InstanceHasUnpaidOrder', 'errorMessage' => 'You have an unpaid order. Complete the payment or cancel the order first.', 'description' => 'You have an unpaid order. Complete the payment or cancel the order first.'], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.', 'description' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.'], + ['errorCode' => 'InsufficientBalance', 'errorMessage' => 'Your account balance is insufficient.', 'description' => 'Your account balance is insufficient, please recharge before purchasing.'], + ['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account balance is insufficient.', 'description' => 'Your account is in arrears, please pay the arrears before purchasing.'], + ['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' => 'The configuration for the upgrade or downgrade is not changed.'], + ['errorCode' => 'InvalidComponent', 'errorMessage' => 'The order parameters is invalid.', 'description' => 'The order parameters is invalid.'], + ['errorCode' => 'RamAuthFailed', 'errorMessage' => 'The sub-account has no operation permission.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Cache Reserve Specification Change', 'summary' => 'Cache Reserve Specification Change', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateCacheReserveSpec', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCacheReserveSpec'], ], ], 'ramActions' => [ @@ -79562,12 +45096,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -79575,13 +45104,9 @@ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40423A7F-A83D-1E24-B80E-86DD25790759\\\\n\\",\\n \\"OrderId\\": \\"2223332122***\\\\n\\",\\n \\"InstanceId\\": \\"esa-cr-9tuv*********\\"\\n}","type":"json"}]', ], 'UpdateCacheRule' => [ - 'summary' => 'Modify cache configuration', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Modify the cache configuration.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -79594,378 +45119,265 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257965', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the site. To get this ID, call the [ListSites](~~ListSites~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '35281609698****', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the rule. This parameter is optional for a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Controls whether the rule is enabled. This parameter is optional for a global configuration. Valid values:'."\n" + ."\n" + .'- `on`: Enables the rule.'."\n" + ."\n" + .'- `off`: Disables the rule.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq \\"video.example.com\\")', - 'title' => '', - ], + 'schema' => ['description' => 'A conditional expression that matches user requests. This parameter is optional for a global configuration. Two scenarios are supported:'."\n" + ."\n" + .'- To match all incoming requests, set the value to `true`.'."\n" + ."\n" + .'- To match specific requests, set the value to a custom expression, for example, `(http.host eq "video.example.com")`.', 'type' => 'string', 'required' => false, 'example' => '(http.host eq \\"video.example.com\\")', 'title' => ''], ], [ 'name' => 'BypassCache', 'in' => 'query', - 'schema' => [ - 'description' => 'Set bypass cache mode. Value range:'."\n" - .'- cache_all: Cache all requests.'."\n" - .'- bypass_all: Bypass cache for all requests.', - 'type' => 'string', - 'required' => false, - 'example' => 'cache_all', - 'title' => '', - ], + 'schema' => ['description' => 'The cache bypass mode. Valid values:'."\n" + ."\n" + .'- `cache_all`: Caches all requests.'."\n" + ."\n" + .'- `bypass_all`: Bypasses the cache for all requests.', 'type' => 'string', 'required' => false, 'example' => 'cache_all', 'title' => ''], ], [ 'name' => 'BrowserCacheMode', 'in' => 'query', - 'schema' => [ - 'description' => 'Browser cache mode. Value range:'."\n" - .'- no_cache: Do not cache.'."\n" - .'- follow_origin: Follow origin cache policy.'."\n" - .'- override_origin: Override origin cache policy.', - 'type' => 'string', - 'required' => false, - 'example' => 'no_cache', - 'title' => '', - ], + 'schema' => ['description' => 'The browser cache mode. Valid values:'."\n" + ."\n" + .'- `no_cache`: Does not cache content in the browser.'."\n" + ."\n" + .'- `follow_origin`: Follows the caching policy of the origin server.'."\n" + ."\n" + .'- `override_origin`: Overrides the caching policy of the origin server.', 'type' => 'string', 'required' => false, 'example' => 'no_cache', 'title' => ''], ], [ 'name' => 'BrowserCacheTtl', 'in' => 'query', - 'schema' => [ - 'description' => 'Browser cache expiration time, in seconds.', - 'type' => 'string', - 'required' => false, - 'example' => '300', - 'title' => '', - ], + 'schema' => ['description' => 'The browser cache TTL (Time to Live), in seconds.', 'type' => 'string', 'required' => false, 'example' => '300', 'title' => ''], ], [ 'name' => 'EdgeCacheMode', 'in' => 'query', - 'schema' => [ - 'description' => 'Edge cache mode. Value range:'."\n" - .'- follow_origin: Follow origin cache policy (if exists), otherwise use the default cache policy.'."\n" - .'- no_cache: Do not cache.'."\n" - .'- override_origin: Override origin cache policy.'."\n" - .'- follow_origin_bypass: Follow origin cache policy (if exists), otherwise do not cache.', - 'type' => 'string', - 'required' => false, - 'example' => 'follow_origin', - 'title' => '', - ], + 'schema' => ['description' => 'The cache mode for the edge node. Valid values:'."\n" + ."\n" + .'- `follow_origin`: Follows the origin server\'s caching policy. If the origin server has no policy, the default policy is used.'."\n" + ."\n" + .'- `no_cache`: Does not cache content.'."\n" + ."\n" + .'- `override_origin`: Overrides the caching policy of the origin server.'."\n" + ."\n" + .'- `follow_origin_bypass`: Follows the caching policy of the origin server, if one exists. Otherwise, content is not cached.'."\n" + ."\n" + .'- `follow_origin_override`: Follows the caching policy of the origin server, if one exists. Otherwise, a custom cache TTL is used.', 'type' => 'string', 'required' => false, 'example' => 'follow_origin', 'title' => ''], ], [ 'name' => 'EdgeCacheTtl', 'in' => 'query', - 'schema' => [ - 'description' => 'Edge cache expiration time, in seconds.', - 'type' => 'string', - 'required' => false, - 'example' => '300', - 'title' => '', - ], + 'schema' => ['description' => 'The edge node cache TTL (Time to Live), in seconds.', 'type' => 'string', 'required' => false, 'example' => '300', 'title' => ''], ], [ 'name' => 'EdgeStatusCodeCacheTtl', 'in' => 'query', - 'schema' => [ - 'description' => 'Status code cache expiration time, in seconds.', - 'type' => 'string', - 'required' => false, - 'example' => '4xx=10', - 'title' => '', - ], + 'schema' => ['description' => 'The cache TTL for specific status codes, in seconds.'."\n" + ."\n" + .'- You can set the cache TTL for a specific status code. For example, `404=10` caches responses with a 404 status code for 10 seconds.'."\n" + ."\n" + .'- You can set the cache TTL for `4xx` and `5xx` status code ranges. For example, `4xx=10` caches all responses with a `4xx` status code for 10 seconds.'."\n" + ."\n" + .'- Separate multiple status code settings with commas.', 'type' => 'string', 'required' => false, 'example' => '5xx=0,404=10', 'title' => ''], ], [ 'name' => 'SortQueryStringForCache', 'in' => 'query', - 'schema' => [ - 'description' => 'Query string sorting. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Controls whether to sort query string parameters when generating a cache key. Valid values:'."\n" + ."\n" + .'- `on`: Enables sorting.'."\n" + ."\n" + .'- `off`: Disables sorting.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'QueryStringMode', 'in' => 'query', - 'schema' => [ - 'description' => 'The processing mode of query strings when generating cache keys. Values:'."\n" - .'- ignore_all: Ignore all.'."\n" - .'- exclude_query_string: Exclude specified query strings.'."\n" - .'- reserve_all: Default, reserve all.'."\n" - .'- include_query_string: Include specified query strings.', - 'type' => 'string', - 'required' => false, - 'example' => 'ignore_all', - 'title' => '', - ], + 'schema' => ['description' => 'Controls how query strings are used to generate a cache key. Valid values:'."\n" + ."\n" + .'- `ignore_all`: Ignores all query strings.'."\n" + ."\n" + .'- `exclude_query_string`: Removes specified query strings.'."\n" + ."\n" + .'- `reserve_all`: Retains all query strings. This is the default value.'."\n" + ."\n" + .'- `include_query_string`: Retains only specified query strings.', 'type' => 'string', 'required' => false, 'example' => 'ignore_all', 'title' => ''], ], [ 'name' => 'QueryString', 'in' => 'query', - 'schema' => [ - 'description' => 'Query strings to be retained or excluded, supporting multiple values separated by spaces.', - 'type' => 'string', - 'required' => false, - 'example' => 'example', - 'title' => '', - ], + 'schema' => ['description' => 'The query string parameters to include in or exclude from the cache key. Separate multiple parameters with spaces.', 'type' => 'string', 'required' => false, 'example' => 'example1 example2', 'title' => ''], ], [ 'name' => 'IncludeHeader', 'in' => 'query', - 'schema' => [ - 'description' => 'Include the specified header names and their values when generating cache keys, supporting multiple values separated by spaces.', - 'type' => 'string', - 'required' => false, - 'example' => 'headername', - 'title' => '', - ], + 'schema' => ['description' => 'The headers to include in the cache key. Both the header names (case-insensitive) and their values are used. Separate multiple headers with spaces. Header names can contain the following characters:'."\n" + ."\n" + .'- Symbols: ! # $ % & \' \\* + - . ^ \\_ | \\~'."\n" + ."\n" + .'- Digits: 0-9'."\n" + ."\n" + .'- Lowercase letters: a-z', 'type' => 'string', 'required' => false, 'example' => 'headername1 headername2', 'title' => ''], ], [ 'name' => 'IncludeCookie', 'in' => 'query', - 'schema' => [ - 'description' => 'Include the specified cookie names and their values when generating cache keys, supporting multiple values separated by spaces.', - 'type' => 'string', - 'required' => false, - 'example' => 'cookiename', - 'title' => '', - ], + 'schema' => ['description' => 'The cookies to include in the cache key. Both the cookie names (case-insensitive) and their values are used. Separate multiple cookies with spaces. Cookie names can contain the following characters:'."\n" + ."\n" + .'- Symbols: ! # $ % & \' \\* + - . ^ \\_ | \\~'."\n" + ."\n" + .'- Digits: 0-9'."\n" + ."\n" + .'- Lowercase letters: a-z', 'type' => 'string', 'required' => false, 'example' => 'cookiename1 cookiename2', 'title' => ''], ], [ 'name' => 'CacheReserveEligibility', 'in' => 'query', - 'schema' => [ - 'description' => 'Cache retention eligibility. Used to control whether user requests bypass the cache retention node when returning to the origin. Value range:'."\n" - .'- bypass_cache_reserve: Requests bypass cache retention.'."\n" - .'- eligible_for_cache_reserve: Eligible for cache retention.', - 'type' => 'string', - 'required' => false, - 'example' => 'bypass_cache_reserve', - 'title' => '', - ], + 'schema' => ['description' => 'Controls whether requests bypass the cache reserve node during an origin-pull. Valid values:'."\n" + ."\n" + .'- `bypass_cache_reserve`: The request bypasses the cache reserve.'."\n" + ."\n" + .'- `eligible_for_cache_reserve`: The request is eligible for cache reserve.', 'type' => 'string', 'required' => false, 'example' => 'bypass_cache_reserve', 'title' => ''], ], [ 'name' => 'CheckPresenceHeader', 'in' => 'query', - 'schema' => [ - 'description' => 'Check if the header exists when generating cache keys, and if it does, add the header name (case-insensitive) to the cache key. Supports multiple header names, separated by spaces.', - 'type' => 'string', - 'required' => false, - 'example' => 'headername', - 'title' => '', - ], + 'schema' => ['description' => 'The headers to check for. If a specified header is present in the request, its name (case-insensitive) is added to the cache key. Separate multiple headers with spaces. Header names can contain the following characters:'."\n" + ."\n" + .'- Symbols: ! # $ % & \' \\* + - . ^ \\_ | \\~'."\n" + ."\n" + .'- Digits: 0-9'."\n" + ."\n" + .'- Lowercase letters: a-z', 'type' => 'string', 'required' => false, 'example' => 'headername1 headername2', 'title' => ''], ], [ 'name' => 'CheckPresenceCookie', 'in' => 'query', - 'schema' => [ - 'description' => 'Check if the cookie exists when generating cache keys, and if it does, add the cookie name (case-insensitive) to the cache key. Supports multiple cookie names, separated by spaces.', - 'type' => 'string', - 'required' => false, - 'example' => 'cookiename', - 'title' => '', - ], + 'schema' => ['description' => 'The cookies to check for. If a specified cookie is present in the request, its name (case-insensitive) is added to the cache key. Separate multiple cookies with spaces. Cookie names can contain the following characters:'."\n" + ."\n" + .'- Symbols: ! # $ % & \' \\* + - . ^ \\_ | \\~'."\n" + ."\n" + .'- Digits: 0-9'."\n" + ."\n" + .'- Lowercase letters: a-z', 'type' => 'string', 'required' => false, 'example' => 'cookiename1 cookiename2', 'title' => ''], ], [ 'name' => 'UserDeviceType', 'in' => 'query', - 'schema' => [ - 'description' => 'When generating cache keys, include the client device type. Value range: '."\n" - .'- on: enabled. '."\n" - .'- off: disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Controls whether to include the client device type in the cache key. Valid values:'."\n" + ."\n" + .'- `on`: Enables this feature.'."\n" + ."\n" + .'- `off`: Disables this feature.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'UserGeo', 'in' => 'query', - 'schema' => [ - 'description' => 'Include the client\'s geographical location when generating the cache key. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Controls whether to include the client\'s geographic location in the cache key. Valid values:'."\n" + ."\n" + .'- `on`: Enables this feature.'."\n" + ."\n" + .'- `off`: Disables this feature.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'UserLanguage', 'in' => 'query', - 'schema' => [ - 'description' => 'Include the client\'s language type when generating the cache key. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Controls whether to include the client\'s language in the cache key. Valid values:'."\n" + ."\n" + .'- `on`: Enables this feature.'."\n" + ."\n" + .'- `off`: Disables this feature.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'ServeStale', 'in' => 'query', - 'schema' => [ - 'description' => 'Serve stale cache. When enabled, the node can still use the expired cached files to respond to user requests even if the origin server is unavailable. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Controls whether to serve stale content. If enabled, an edge node can serve expired content from its cache if the origin server is unavailable. Valid values:'."\n" + ."\n" + .'- `on`: Enables this feature.'."\n" + ."\n" + .'- `off`: Disables this feature.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'AdditionalCacheablePorts', 'in' => 'query', - 'schema' => [ - 'description' => 'Enable caching on specified ports. Value range: 8880, 2052, 2082, 2086, 2095, 2053, 2083, 2087, 2096.', - 'type' => 'string', - 'required' => false, - 'example' => '8880', - 'title' => '', - ], + 'schema' => ['description' => '- Enables caching on the specified ports.'."\n" + ."\n" + .'- Valid values: `8880`, `2052`, `2082`, `2086`, `2095`, `2053`, `2083`, `2087`, `2096`'."\n" + ."\n" + .'- Separate multiple ports with commas.', 'type' => 'string', 'required' => false, 'example' => '8880,2052,2086', 'title' => ''], ], [ 'name' => 'CacheDeceptionArmor', 'in' => 'query', - 'schema' => [ - 'description' => 'Cache deception defense. Used to defend against web cache deception attacks; only the cache content that passes the validation will be cached. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Defends against Web Cache Deception attacks by caching only validated content. Valid values:'."\n" + ."\n" + .'- `on`: Enables the feature.'."\n" + ."\n" + .'- `off`: Disables the feature.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule execution order. Rules with smaller numeric values are executed first.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The execution priority of the rule. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PostCache', 'in' => 'query', - 'schema' => [ - 'description' => 'Toggle for the Post cache feature.', - 'title' => 'Toggle for the Post cache feature.', - 'type' => 'string', - 'example' => 'on', - 'required' => false, - ], + 'schema' => ['title' => 'Toggle for the Post cache feature.', 'description' => 'Controls whether to cache responses to POST requests.', 'type' => 'string', 'example' => 'on', 'required' => false], ], [ 'name' => 'PostBodySizeLimit', 'in' => 'query', - 'schema' => [ - 'description' => 'Body size limit. The value is a numeric value in KB. Body sizes from 1 KB to 8 KB are supported. If the value is empty, it defaults to 8 KB.', - 'type' => 'string', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The maximum size of a request body for POST caching, in KB. The value must be an integer from 1 to 8. If you leave this parameter empty, the default value of 8 KB is used.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PostBodyCacheKey', 'in' => 'query', - 'schema' => [ - 'description' => 'Processing pattern for the cache key.', - 'title' => 'Processing pattern for the cache key.', - 'type' => 'string', - 'example' => 'ignore', - 'required' => false, - ], + 'schema' => ['title' => 'Processing pattern for the cache key.', 'description' => 'Controls how the request body is used to generate the cache key for POST requests. Valid values:'."\n" + ."\n" + .'- `md5`: Calculates the MD5 hash of the request body and includes the hash in the cache key.'."\n" + ."\n" + .'- `ignore`: Ignores the request body when generating the cache key.', 'type' => 'string', 'example' => 'ignore', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], ], 'example' => '', ], @@ -79973,205 +45385,93 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\"\\n}","type":"json"}]', 'title' => 'Modify Site Cache Configuration', 'changeSet' => [ - [ - 'createdAt' => '2025-03-27T02:58:48.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-03-27T02:58:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateCacheRule', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCacheRule'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateCacheRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\"\\n}","type":"json"}]', ], 'UpdateCacheTag' => [ - 'summary' => 'Modifies the cache tag configuration of your website. You can call this operation when you need to specify tags in the Cache-Tag response header to use the purge by cache tag feature.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Modifies the cache tag configuration of your website.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257332', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '5407498413****', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5407498413****', 'title' => ''], ], [ 'name' => 'TagName', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the custom cache tag.'."\n", + 'description' => 'The name of the custom cache tag.', 'type' => 'string', 'required' => false, - 'example' => 'example', 'enum' => [], + 'example' => 'example', 'title' => '', ], ], @@ -80181,14 +45481,12 @@ 'schema' => [ 'description' => 'Specifies whether to ignore case sensitivity. Valid values:'."\n" ."\n" - .'* on'."\n" - .'* off'."\n", + .'- on'."\n" + ."\n" + .'- off', + 'enumValueTitles' => ['off' => 'off', 'on' => 'on'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], 'example' => 'on', 'title' => '', ], @@ -80196,29 +45494,17 @@ [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE'], ], 'example' => '', ], @@ -80226,109 +45512,33 @@ ], '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UpdateCacheTag', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateCacheTag', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCacheTag'], ], ], 'ramActions' => [ @@ -80339,26 +45549,17 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'operationType' => 'write', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\"\\n}","type":"json"}]', ], 'UpdateCnameFlattening' => [ 'summary' => 'Modifies the CNAME flattening configuration of a website.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -80370,22 +45571,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257389', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'FlattenMode', @@ -80398,10 +45590,7 @@ 'type' => 'string', 'required' => true, 'example' => 'flatten_all', - 'enum' => [ - 'flatten_all', - 'flatten_at_root', - ], + 'enum' => ['flatten_all', 'flatten_at_root'], 'title' => '', ], ], @@ -80413,12 +45602,7 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE'], ], 'example' => '', ], @@ -80426,124 +45610,37 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.', - ], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\"\\n}","type":"json"}]', 'title' => 'UpdateCnameFlattening', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateCnameFlattening', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCnameFlattening'], ], ], 'ramActions' => [ @@ -80554,12 +45651,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -80567,13 +45659,9 @@ 'operationType' => 'write', ], 'UpdateCompressionRule' => [ - 'summary' => 'Modify compression rule', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Modifies the compression rule configuration of a site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -80586,90 +45674,57 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257664', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '5407498413****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5407498413****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID. It can be obtained by calling the [ListCompressionRules](~~ListCompressionRules~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID. You can call the [ListCompressionRules](~~ListCompressionRules~~) operation to obtain the configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '35281609698****', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. You do not need to set this parameter when adding a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', + 'description' => 'The rule switch. You do not need to set this parameter when adding a global configuration. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- To match all incoming requests: Set the value to true'."\n" - .'- To match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], + 'schema' => ['description' => 'The rule content, which uses a conditional expression to match user requests. You do not need to set this parameter when adding a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + .'- Match specified requests: Set the value to a custom expression, such as (http.host eq \\"video.example.com\\").', 'type' => 'string', 'required' => false, 'example' => '(http.host eq "video.example.com")', 'title' => ''], ], [ 'name' => 'Brotli', 'in' => 'query', 'schema' => [ - 'description' => 'Brotli compression. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', + 'description' => 'Brotli compression. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', - 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], + 'required' => false, 'title' => '', ], ], @@ -80677,16 +45732,13 @@ 'name' => 'Gzip', 'in' => 'query', 'schema' => [ - 'description' => 'Gzip compression. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', + 'description' => 'Gzip compression. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', - 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], + 'required' => false, 'title' => '', ], ], @@ -80694,45 +45746,30 @@ 'name' => 'Zstd', 'in' => 'query', 'schema' => [ - 'description' => 'Zstd compression. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', + 'description' => 'Zstd compression. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', - 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], + 'required' => false, 'title' => '', ], ], [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule execution order. A smaller numeric value indicates higher priority. ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Request response result.', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'CE8EB0DE-3267-53D1-AB83-F36377D63FD0', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CE8EB0DE-3267-53D1-AB83-F36377D63FD0'], ], 'example' => '', ], @@ -80740,187 +45777,68 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => '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.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => '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.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'Modify Compression Rule Configuration', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE8EB0DE-3267-53D1-AB83-F36377D63FD0\\"\\n}","type":"json"}]', + 'title' => 'Modify compression rule configuration', 'changeSet' => [ - [ - 'createdAt' => '2025-03-27T02:58:48.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2025-02-12T02:25:42.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-03-27T02:58:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-12T02:25:42.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateCompressionRule', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCompressionRule'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateCompressionRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE8EB0DE-3267-53D1-AB83-F36377D63FD0\\"\\n}","type":"json"}]', ], 'UpdateCrossBorderOptimization' => [ - 'summary' => 'Modifies the configuration of the Chinese mainland network access optimization.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Modifies the China mainland network access optimization configuration for a site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -80933,37 +45851,26 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257427', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'Enable', 'in' => 'query', 'schema' => [ - 'description' => 'Whether to enable Chinese mainland network access optimization. By default, it is disabled. Valid values:'."\n" + 'description' => 'Specifies whether to enable China mainland network access optimization. This feature is disabled by default. Valid values:'."\n" ."\n" - .'* on'."\n" - .'* off'."\n", + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', 'required' => true, - 'enum' => [ - 'on', - 'off', - ], + 'enum' => ['on', 'off'], 'example' => 'on', 'title' => '', ], @@ -80972,16 +45879,11 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'], ], 'example' => '', ], @@ -80989,138 +45891,41 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.', - ], - [ - 'errorCode' => 'CanNotOpenCrossBorderOptimization', - 'errorMessage' => 'Can not open cross border optimization.', - 'description' => 'Can not open cross border optimization.', - ], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.'], + ['errorCode' => 'CanNotOpenCrossBorderOptimization', 'errorMessage' => 'Can not open cross border optimization.', 'description' => 'Can not open cross border optimization.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'UpdateCrossBorderOptimization', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\"\\n}","type":"json"}]', + 'title' => 'Modify China mainland network access optimization configuration for a site', + 'description' => 'The site plan must be Enterprise Edition or higher to enable China mainland network access optimization.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateCrossBorderOptimization', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCrossBorderOptimization'], ], ], 'ramActions' => [ @@ -81131,25 +45936,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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', - ], + 'summary' => 'Updates a SaaS domain name. You can modify the bound record ID, certificate type, and other settings.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -81162,54 +45958,34 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239650', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4DMKZ4', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4DMKZ4'], ], 'parameters' => [ [ 'name' => 'HostnameId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The ID of the SaaS domain name. You can obtain the ID by calling the [ListCustomHostnames](~~3018667~~) operation.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'title' => '', - 'example' => '1234567890123', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the SaaS domain name. You can obtain the ID by calling the [ListCustomHostnames](~~3018667~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123'], ], [ 'name' => 'RecordId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The ID of the record to attach. You can obtain the ID by calling the [ListRecords](~~2850265~~) operation.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'title' => '', - 'example' => '1234567890123', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the record to bind. You can obtain the ID by calling the [ListRecords](~~2850265~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234567890123'], ], [ 'name' => 'SslFlag', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ - 'description' => 'The SSL switch.'."\n" - ."\n" + 'title' => '', + 'description' => 'The SSL switch. Valid values:'."\n" .'- **on**: Enables SSL.'."\n" - ."\n" .'- **off**: Disables SSL.', + 'enumValueTitles' => ['off' => 'Disables SSL.', 'on' => 'Enables SSL.'], 'type' => 'string', 'required' => false, - 'enum' => [ - 'on', - 'off', - ], - 'title' => '', + 'enum' => ['on', 'off'], 'example' => 'on', ], ], @@ -81217,20 +45993,14 @@ 'name' => 'CertType', 'in' => 'query', 'schema' => [ - 'description' => 'The certificate type. This parameter is required when SslFlag is set to on.'."\n" - ."\n" - .'- **free**: Free certificate.'."\n" - ."\n" - .'- **upload**: Uploaded certificate.'."\n" - ."\n" - .'- **cas**: Alibaba Cloud Security certificate.', - 'type' => 'string', - 'enum' => [ - 'free', - 'upload', - 'cas', - ], 'title' => '', + 'description' => 'The certificate type. This parameter is required when SslFlag is set to on. Valid values:'."\n" + .'- **free**: free certificate.'."\n" + .'- **upload**: uploaded certificate.'."\n" + .'- **cas**: SSL Certificates Service certificate.', + 'enumValueTitles' => ['cas' => 'SSL Certificates Service certificate.', 'upload' => 'Uploaded certificate.', 'free' => 'Free certificate.'], + 'type' => 'string', + 'enum' => ['free', 'upload', 'cas'], 'required' => false, 'example' => 'cas', ], @@ -81239,53 +46009,26 @@ 'name' => 'Certificate', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The content of the certificate. This parameter is required when CertType is set to upload.', - 'type' => 'string', - 'title' => '', - 'required' => false, - 'example' => '-----BEGIN CERTIFICATE-----', - ], + 'schema' => ['title' => '', 'description' => 'The certificate content. This parameter is required when CertType is set to upload.', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN CERTIFICATE-----'], ], [ 'name' => 'PrivateKey', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The private key of the certificate. This parameter is required when CertType is set to upload.', - 'type' => 'string', - 'title' => '', - 'required' => false, - 'example' => '-----BEGIN PRIVATE KEY-----', - ], + 'schema' => ['title' => '', 'description' => 'The certificate private key. This parameter is required when CertType is set to upload.', 'type' => 'string', 'required' => false, 'example' => '-----BEGIN PRIVATE KEY-----'], ], [ 'name' => 'CasId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud Security certificate. This parameter is required when CertType is set to cas.', - 'type' => 'integer', - 'format' => 'int64', - 'title' => '', - 'required' => false, - 'example' => '30000478'."\n", - ], + 'schema' => ['title' => '', 'description' => 'The ID of the SSL Certificates Service certificate. This parameter is required when CertType is set to cas.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30000478'."\n"], ], [ 'name' => 'CasRegion', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The region of the Alibaba Cloud Security certificate. This parameter is required when CertType is set to cas.'."\n" - ."\n" - .'- cn-hangzhou: The value for accounts on the Alibaba Cloud China Website (www\\.aliyun.com).'."\n" - ."\n" - .'- ap-southeast-1: The value for accounts on the Alibaba Cloud International Website (www\\.alibabacloud.com).', - 'type' => 'string', - 'title' => '', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The region of the SSL Certificates Service certificate. This parameter is required when CertType is set to cas. Valid values:'."\n" + .'- Chinese mainland accounts: cn-hangzhou.'."\n" + .'- International accounts: ap-southeast-1.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -81293,12 +46036,7 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', 'title' => ''], ], 'description' => '', 'title' => '', @@ -81308,70 +46046,52 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'Record.ServiceBusy', - 'errorMessage' => 'The record is being configured. Try again later.', - 'description' => 'The record is being configured. Try again later.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => '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.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'Record.ServiceBusy', 'errorMessage' => 'The record is being configured. Try again later.', 'description' => 'The record is being configured. Try again later.'], + ['errorCode' => 'CustomHostname.QueryCasCertFailed', 'errorMessage' => 'Fail to query CAS certificate details. Please try again later.', 'description' => ''], + ['errorCode' => 'CustomHostname.CheckQuotaFailed', 'errorMessage' => 'Fail to check quota for custom hostname. Please try again later.', 'description' => ''], + ['errorCode' => 'QuotaExceed.CustomHostname', 'errorMessage' => 'The number of custom hostnames exceeds the plan quota. Contact the sales team to increase your quota.', 'description' => 'The number of custom hostnames exceeds the plan quota. Contact the sales team to increase your quota.'], + ['errorCode' => 'CustomHostname.OfflineForMultiReason', 'errorMessage' => 'Unable to activate the custom hostname because it is offline due to multiple reasons.', 'description' => ''], ], 404 => [ - [ - 'errorCode' => 'CustomHostname.NotFound', - 'errorMessage' => 'The custom hostname does not exist. Modify it and try again.', - 'description' => 'The custom hostname does not exist. Modify it and try again.', - ], - [ - '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' => '', - ], + ['errorCode' => 'CustomHostname.NotFound', 'errorMessage' => 'The custom hostname does not exist. Modify it and try again.', 'description' => 'The custom hostname does not exist. Modify it and try again.'], + ['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' => 'UpdateCustomHostname', - 'summary' => 'Updates the parameters of a Software as a Service (SaaS) domain name, such as the attached record ID and the certificate type.', + 'title' => 'Update a saaS domain name', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCustomHostname'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateCustomHostname', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', ], 'UpdateCustomResponseCodeRule' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Modifies the response code rewrite configuration of a site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -81384,60 +46104,34 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257647', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The site ID. Get it by calling the [ListSites](~~2850189~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '437375513708224', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '437375513708224', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '352816096987136', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '352816096987136', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'The rule name. Do not set this parameter when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. You do not need to set this parameter when adding a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example'."\n", 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', 'schema' => [ - 'description' => 'The rule switch. Do not set this parameter when adding a global configuration. Valid values:'."\n" - ."\n" - .'- on: Enable the rule.'."\n" - ."\n" - .'- off: Disable the rule.', + 'description' => 'The rule switch. You do not need to set this parameter when adding a global configuration. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', - 'enum' => [ - 'on', - 'off', - ], + 'enum' => ['on', 'off'], 'required' => false, 'example' => 'on', 'title' => '', @@ -81446,66 +46140,34 @@ [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'The rule content. Use a conditional expression to match user requests. Do not set this parameter when adding a global configuration. There are two scenarios:'."\n" - ."\n" - .'- Match all incoming requests: Set the value to \\`true\\`.'."\n" - ."\n" - .'- Match specific requests: Set the value to a custom expression, such as: \\`(http.host eq "video.example.com")\\`.', - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], + 'schema' => ['description' => 'The rule content, which uses a conditional expression to match user requests. You do not need to set this parameter when adding a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + .'- Match specified requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\").', 'type' => 'string', 'required' => false, 'example' => '(http.host eq "video.example.com")', 'title' => ''], ], [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'The rule execution order. A smaller value indicates higher priority.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'ReturnCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The response code.', - 'type' => 'string', - 'required' => false, - 'example' => '200', - 'title' => '', - ], + 'schema' => ['description' => 'The response code.', 'type' => 'string', 'required' => false, 'example' => '200', 'title' => ''], ], [ 'name' => 'PageId', 'in' => 'query', - 'schema' => [ - 'description' => 'The response page.', - 'type' => 'string', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The response page.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'The request response result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => 'C7518056-E30F-55F8-97DD-004D8030703B', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C7518056-E30F-55F8-97DD-004D8030703B'], ], 'example' => '', ], @@ -81513,184 +46175,67 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'VerifyExpressionError', - 'errorMessage' => 'Dynamic expression is invalid.', - 'description' => 'Dynamic expression is invalid.', - ], - [ - 'errorCode' => 'InvalidValOfDelHeader', - 'errorMessage' => 'The delete header operation does not support setting value.', - 'description' => 'The delete header operation does not support setting value.', - ], - [ - 'errorCode' => 'SiteFunction.WafPageNotExist', - 'errorMessage' => 'The custom page referenced in the custom response code configuration does not exist.', - 'description' => 'The custom page referenced in the custom response code configuration does not exist.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => '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.'], + ['errorCode' => 'VerifyExpressionError', 'errorMessage' => 'Dynamic expression is invalid.', 'description' => 'Dynamic expression is invalid.'], + ['errorCode' => 'InvalidValOfDelHeader', 'errorMessage' => 'The delete header operation does not support setting value.', 'description' => 'The delete header operation does not support setting value.'], + ['errorCode' => 'SiteFunction.WafPageNotExist', 'errorMessage' => 'The custom page referenced in the custom response code configuration does not exist.', 'description' => 'The custom page referenced in the custom response code configuration does not exist.'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'UpdateCustomResponseCodeRule', - 'summary' => 'Modify the response code configuration for a site.', + 'title' => 'Update response code rewrite configuration', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCustomResponseCodeRule'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateCustomResponseCodeRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], + ], + ], ], - 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C7518056-E30F-55F8-97DD-004D8030703B\\"\\n}","type":"json"}]', ], 'UpdateCustomScenePolicy' => [ - 'summary' => 'Modify the specified scenario-specific policy configuration information. ', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Updates a specified custom scene policy.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -81703,170 +46248,89 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239280', - 'abilityTreeNodes' => [ - 'FEATUREdcdnL8HX1L', - ], + 'abilityTreeNodes' => ['FEATUREdcdnL8HX1L'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The policy name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - 'maxLength' => 128, - 'title' => '', - ], + 'schema' => ['description' => 'The name of the policy.', 'type' => 'string', 'required' => true, 'maxLength' => 128, 'example' => 'test', 'title' => ''], ], [ 'name' => 'Template', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the policy template. Valid value:'."\n" + 'description' => 'The name of the template. Valid value:'."\n" ."\n" - .'* **promotion**: major events.'."\n", + .'- **promotion**: major promotion', 'type' => 'string', 'required' => true, + 'enum' => ['promotion'], 'example' => 'promotion', - 'enum' => [ - 'promotion', - ], 'title' => '', ], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the policy takes effect.'."\n" - ."\n" - .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2023-04-03T16:00:00Z', - 'title' => '', - ], + 'schema' => ['description' => 'The start time of the policy.'."\n" + ."\n" + .'The time must be in UTC and in the ISO 8601 format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => true, 'example' => '2023-04-03T16:00:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the policy expires.'."\n" - ."\n" - .'Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2023-04-03T19:00:00Z'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The end time of the policy.'."\n" + ."\n" + .'The time must be in UTC and in the ISO 8601 format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => true, 'example' => '2023-04-03T19:00:00Z'."\n", 'title' => ''], ], [ 'name' => 'Objects', 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the websites that you want to associate with the policy. Separate multiple IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123456****,123457****'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The site IDs to associate with the policy. Use a comma (,) to separate multiple IDs.'."\n" + ."\n" + .'> This parameter is deprecated. We recommend using the `SiteIds` parameter instead. If the `SiteIds` parameter is specified, the `Objects` parameter is ignored. You must specify a value for either the `Objects` or `SiteIds` parameter.', 'type' => 'string', 'required' => false, 'example' => '123456****,123457****'."\n", 'title' => ''], ], [ 'name' => 'PolicyId', 'in' => 'query', - 'schema' => [ - 'description' => 'The policy ID, which can be obtained by calling the [DescribeCustomScenePolicies](~~2850508~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '1', - 'exclusiveMinimum' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'To obtain the policy ID, call the [DescribeCustomScenePolicies](~~2850508~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'exclusiveMinimum' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'SiteIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The site IDs to associate, separated by commas (,). ', - 'type' => 'string', - 'title' => '', - 'required' => false, - 'example' => '123456****,123457****'."\n", - ], + 'schema' => ['description' => 'The site IDs to associate with the policy. Use a comma (,) to separate multiple IDs.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '123456****,123457****'."\n"], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The data returned by the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - ], - 'Name' => [ - 'description' => 'The policy name.'."\n", - 'type' => 'string', - 'example' => 'test', - 'title' => '', - ], - 'Template' => [ - 'description' => 'The name of the policy template. Valid value:'."\n" - ."\n" - .'* **promotion**: major events.'."\n", - 'type' => 'string', - 'example' => 'promotion', - 'title' => '', - ], - 'StartTime' => [ - 'description' => 'The time when the policy takes effect.'."\n" - ."\n" - .'The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-04-03T16:00:00Z'."\n", - 'title' => '', - ], - 'EndTime' => [ - 'description' => 'The time when the policy expires.'."\n" - ."\n" - .'The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-04-03T19:00:00Z'."\n", - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'], + 'Name' => ['description' => 'The name of the policy.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Template' => ['description' => 'The name of the template. Valid value:'."\n" + ."\n" + .'- **promotion**: major promotion', 'type' => 'string', 'example' => 'promotion', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the policy.'."\n" + ."\n" + .'The time is in UTC and in the ISO 8601 format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2023-04-03T16:00:00Z'."\n", 'title' => ''], + 'EndTime' => ['description' => 'The end time of the policy.'."\n" + ."\n" + .'The time is in UTC and in the ISO 8601 format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2023-04-03T19:00:00Z'."\n", 'title' => ''], 'Objects' => [ - 'description' => 'The IDs of websites associated.'."\n", + 'description' => 'A list of associated site IDs.'."\n" + ."\n" + .'> This parameter is deprecated. We recommend that you use the `SiteIds` parameter instead.', 'type' => 'array', - 'items' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'string', - 'example' => '123456****', - 'title' => '', - ], + 'items' => ['description' => 'A site ID.', 'type' => 'string', 'example' => '123456****', 'title' => ''], 'title' => '', 'example' => '', ], - 'PolicyId' => [ - 'description' => 'The policy ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'title' => '', - ], - 'SiteIds' => [ - 'description' => 'The site IDs to associate, separated by commas (,). ', - 'type' => 'string', - 'example' => '123456****,123457****'."\n", - 'title' => '', - ], + 'PolicyId' => ['description' => 'The ID of the policy.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'SiteIds' => ['description' => 'The associated site IDs. Multiple IDs are separated by a comma (,).', 'type' => 'string', 'example' => '123456****,123457****'."\n", 'title' => ''], ], 'example' => '', ], @@ -81874,59 +46338,24 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'PolicyNameExist', - 'errorMessage' => 'The policy name already exists.', - 'description' => 'Policy name already exists.', - ], - [ - 'errorCode' => 'CreateTimeError', - 'errorMessage' => 'The effective time of the same policy template cannot overlap.', - 'description' => 'The effective time of the same policy template cannot overlap.', - ], - [ - 'errorCode' => 'PolicyNotExist', - 'errorMessage' => 'The policy does not exist.', - 'description' => 'The policy does not exist. ', - ], - [ - 'errorCode' => 'InvalidParameter.ObjectsAndSiteIds', - 'errorMessage' => 'The specified Objects and SiteIds variables cannot both be empty strings.', - 'description' => 'The specified Objects and SiteIds variables cannot both be empty strings.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'PolicyNameExist', 'errorMessage' => 'The policy name already exists.', 'description' => 'Policy name already exists.'], + ['errorCode' => 'CreateTimeError', 'errorMessage' => 'The effective time of the same policy template cannot overlap.', 'description' => 'The effective time of the same policy template cannot overlap.'], + ['errorCode' => 'PolicyNotExist', 'errorMessage' => 'The policy does not exist.', 'description' => 'The policy does not exist. '], + ['errorCode' => 'InvalidParameter.ObjectsAndSiteIds', 'errorMessage' => 'The specified Objects and SiteIds variables cannot both be empty strings.', 'description' => 'The specified Objects and SiteIds variables cannot both be empty strings.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], 'title' => 'Modify a scenario-specific policy ', 'changeSet' => [ - [ - 'createdAt' => '2025-06-03T09:31:40.000Z', - 'description' => 'Error codes changed, Request parameters changed, Response parameters changed', - ], - [ - 'createdAt' => '2025-03-12T02:36:32.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-06-03T09:31:40.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-03-12T02:36:32.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateCustomScenePolicy', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCustomScenePolicy'], ], ], 'ramActions' => [ @@ -81937,12 +46366,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -81951,12 +46375,8 @@ ], 'UpdateDevelopmentMode' => [ 'summary' => 'Modifies the development mode configuration of your website. If you enable Development Mode, all requests bypass caching components on POPs and are redirected to the origin server. This allows clients to retrieve the most recent resources on the origin server.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -81968,22 +46388,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257405', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'Enable', @@ -81995,10 +46406,7 @@ .'* off'."\n", 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], + 'enumValueTitles' => ['off' => 'off', 'on' => 'on'], 'example' => 'on', 'enum' => [], 'title' => '', @@ -82012,12 +46420,7 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '65C66B7B-671A-8297-9187-2R5477247B76', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '65C66B7B-671A-8297-9187-2R5477247B76'], ], 'example' => '', ], @@ -82025,114 +46428,35 @@ ], '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65C66B7B-671A-8297-9187-2R5477247B76\\"\\n}","type":"json"}]', 'title' => 'UpdateDevelopmentMode', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateDevelopmentMode', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDevelopmentMode'], ], ], 'ramActions' => [ @@ -82143,12 +46467,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -82156,13 +46475,9 @@ 'operationType' => 'write', ], 'UpdateEdgeContainerAppLogRiver' => [ - 'summary' => 'Updates the log collection configuration of a containerized application.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Updates the log collection configuration of an edge container application.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -82175,70 +46490,36 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '249447', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~2852396~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'app-88068867578379****', - 'title' => '', - ], + 'schema' => ['description' => 'The application ID. You can call the [ListEdgeContainerApps](~~2852396~~) operation to obtain the application ID.'."\n" + .'>The AppId is in the format of the app- prefix followed by a numeric suffix, with a total length of 20 to 64 characters (example: app-8806886***83794688). Call ListEdgeContainerApps to obtain an existing AppId, or call CreateEdgeContainerApp to create an application first..', 'type' => 'string', 'required' => false, 'example' => 'app-88068867578379****', 'title' => ''], ], [ 'name' => 'Stdout', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to collect the standard output of the container.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable standard output collection for the container.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'Path', 'in' => 'query', - 'schema' => [ - 'description' => 'The log path of the container.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/root/hello.log', - 'title' => '', - ], + 'schema' => ['description' => 'The log file of the container.', 'type' => 'string', 'required' => false, 'example' => '/root/hello.log', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '42DE97FA-45D2-5615-9A31-55D9EC0D7563', - ], - 'Stdout' => [ - 'description' => 'Indicates whether the standard output of the container is collected.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], - 'Path' => [ - 'description' => 'The log path of the container.'."\n", - 'type' => 'string', - 'example' => '/root/hello.log', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '42DE97FA-45D2-5615-9A31-55D9EC0D7563'], + 'Stdout' => ['description' => 'Specifies whether to enable standard output collection for the container.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Path' => ['description' => 'The log file of the container.', 'type' => 'string', 'example' => '/root/hello.log', 'title' => ''], ], 'example' => '', ], @@ -82246,75 +46527,31 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', - 'description' => 'Invalid parameter. Check the parameter configuration.', - ], + ['errorCode' => 'InvalidParameter.appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', 'description' => 'Invalid parameter. Check the parameter configuration.'], ], 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42DE97FA-45D2-5615-9A31-55D9EC0D7563\\",\\n \\"Stdout\\": true,\\n \\"Path\\": \\"/root/hello.log\\"\\n}","type":"json"}]', - 'title' => 'UpdateEdgeContainerAppLogRiver', + 'title' => 'Update edge container log collection configuration', '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEdgeContainerAppLogRiver'], ], ], + 'ramActions' => [], ], 'UpdateEdgeContainerAppResourceReserve' => [ - 'summary' => 'Updates the resource reservation configuration of an edge container.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Updates the resource reservation configuration of an edge container application.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -82327,123 +46564,83 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '264840', - 'abilityTreeNodes' => [ - 'FEATUREdcdnFPSR60', - ], + 'abilityTreeNodes' => ['FEATUREdcdnFPSR60'], ], 'parameters' => [ [ 'name' => 'Enable', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable resource reservation.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable resource reservation.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'Forever', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to permanently enable the reservation. Once it is enabled, you are not allowed to set the reservation deadline.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to permanently enable reservation. Once enabled, you cannot set a reservation end time.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'DurationTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The end time of the reservation. The input time is UTC. It takes +8 hours to enter Beijing time. For example, if the current time is 2006-01-02 06:04:05, you need to enter "2006-01-02T14:04:05Z".'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2006-01-02T15:04:05Z', - 'title' => '', - ], + 'schema' => ['description' => 'The reservation end time. This parameter uses UTC time. To convert from UTC+8, add 8 hours. For example, if the current time is 2006-01-02 06:04:05 in UTC+8, enter "2006-01-02T14:04:05Z".', 'type' => 'string', 'required' => false, 'example' => '2006-01-02T15:04:05Z', 'title' => ''], ], [ 'name' => 'ReserveSet', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'Reserved resource list.'."\n", + 'description' => 'The list of reserved resources.', 'type' => 'array', 'items' => [ - 'description' => 'The reserved region object.'."\n", + 'description' => 'The reserved region object.', 'type' => 'object', 'properties' => [ - 'Region' => [ - 'description' => 'Information about the region. The Chinese mainland supports the input of regions and special administrative regions, and the regions outside the Chinese mainland support the input of countries. The following is the corresponding parameter mapping:'."\n" - ."\n" - .'Chinese mainland:'."\n" - ."\n" - .'* East China: huadong'."\n" - .'* South China: huanan'."\n" - .'* Central China: huazhong'."\n" - .'* North China: huabei'."\n" - .'* Northwest China: xibei'."\n" - .'* Southwest China: xinan'."\n" - .'* Northeast China: dongbei'."\n" - ."\n" - .'Special Administrative Regions and overseas:'."\n" - ."\n" - .'* Taiwan, China: tw'."\n" - .'* Macau, China: mo'."\n" - .'* Hong Kong, China: hk'."\n" - .'* Japan: jp'."\n" - .'* United States: us'."\n" - .'* Thailand: th'."\n" - .'* Korea: kr'."\n" - .'* Russia: ru'."\n" - .'* Singapore: sg'."\n" - .'* France: fr'."\n" - .'* Spain: es'."\n" - .'* Italy: it'."\n" - .'* Sweden: se'."\n" - .'* UAE: ae'."\n" - .'* Indonesia: id'."\n" - .'* Chile: cl'."\n" - .'* Philippines: ph'."\n" - .'* Malaysia: my'."\n" - .'* Vietnam: vn'."\n" - .'* Argentina: AR'."\n" - .'* Australia: au'."\n" - .'* Brazil: br'."\n" - .'* Colombia: co'."\n" - .'* Germany: de'."\n" - .'* UK: GB'."\n" - .'* Peru: pe'."\n" - .'* Saudi Arabia: sa'."\n" - .'* Netherlands: nl'."\n" - .'* South Africa: za'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'huazhong', - 'title' => '', - ], - 'Isp' => [ - 'description' => 'The ISP. The following types are supported. You do not need to enter the ISP in regions outside the Chinese mainland:'."\n" - ."\n" - .'* China Mobile: cmcc'."\n" - .'* China Telecom: chinanet'."\n" - .'* China Unicom: unicom'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cmcc', - 'title' => '', - ], - 'Replicas' => [ - 'description' => 'The number of container replicas.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'Region' => ['description' => 'The region information. For the Chinese mainland, you can specify a major region. For special administrative regions and areas outside China, you can specify a country or region. The following list shows the parameter mappings:'."\n" + ."\n" + .'Chinese mainland:'."\n" + ."\n" + .'- East China: huadong'."\n" + .'- South China: huanan'."\n" + .'- Central China: huazhong'."\n" + .'- North China: huabei'."\n" + .'- Northwest China: xibei'."\n" + .'- Southwest China: xinan'."\n" + .'- Northeast China: dongbei'."\n" + ."\n" + .'Special administrative regions and outside China:'."\n" + .'- Taiwan (China): tw'."\n" + .'- Macao (China): mo'."\n" + .'- Hong Kong (China): hk'."\n" + .'- Japan: jp'."\n" + .'- United States: us'."\n" + .'- Thailand: th'."\n" + .'- South Korea: kr'."\n" + .'- Russia: ru'."\n" + .'- Singapore: sg'."\n" + .'- France: fr'."\n" + .'- Spain: es'."\n" + .'- Italy: it'."\n" + .'- Sweden: se'."\n" + .'- United Arab Emirates: ae'."\n" + .'- Indonesia: id'."\n" + .'- Chile: cl'."\n" + .'- Philippines: ph'."\n" + .'- Malaysia: my'."\n" + .'- Vietnam: vn'."\n" + .'- Argentina: ar'."\n" + .'- Australia: au'."\n" + .'- Brazil: br'."\n" + .'- Colombia: co'."\n" + .'- Germany: de'."\n" + .'- United Kingdom: gb'."\n" + .'- Peru: pe'."\n" + .'- Saudi Arabia: sa'."\n" + .'- Netherlands: nl'."\n" + .'- South Africa: za.', 'type' => 'string', 'required' => false, 'example' => 'huazhong', 'title' => ''], + 'Isp' => ['description' => 'The Internet service provider (ISP). The following ISPs are supported. You do not need to specify an ISP for special administrative regions or areas outside China:'."\n" + ."\n" + .'- China Mobile: cmcc'."\n" + .'- China Telecom: chinanet'."\n" + .'- China Unicom: unicom.', 'type' => 'string', 'required' => false, 'example' => 'cmcc', 'title' => ''], + 'Replicas' => ['description' => 'The number of container replicas.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], 'required' => false, 'title' => '', @@ -82457,118 +46654,76 @@ [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'app-88068867578379****', - 'title' => '', - ], + 'schema' => ['description' => 'The application ID. You can call the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation to obtain the application ID.'."\n" + .'>The AppId format is the app- prefix followed by a numeric suffix, with a total length of 20 to 64 characters (example: app-8806886***83794688). Call ListEdgeContainerApps to obtain an existing AppId, or call CreateEdgeContainerApp to create an application first..', 'type' => 'string', 'required' => false, 'example' => 'app-88068867578379****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AB799CF-562A-5CAF-A99E-4354053D814F', - ], - 'Enable' => [ - 'description' => 'Whether to enable resource reservation.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], - 'Forever' => [ - 'description' => 'Enable Permanent Incremental Backup'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], - 'DurationTime' => [ - 'description' => 'The end time of the reservation. The input time is UTC. It takes +8 hours to enter Beijing time. For example, if the current time is 2006-01-02 06:04:05, you need to enter "2006-01-02T14:04:05Z".'."\n", - 'type' => 'string', - 'example' => '2006-01-02T15:04:05Z', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1AB799CF-562A-5CAF-A99E-4354053D814F'], + 'Enable' => ['description' => 'Specifies whether to enable resource reservation.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Forever' => ['description' => 'Indicates whether reservation is permanently enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'DurationTime' => ['description' => 'The reservation end time. This parameter uses UTC time. To convert from UTC+8, add 8 hours. For example, if the current time is 2006-01-02 06:04:05 in UTC+8, enter "2006-01-02T14:04:05Z".', 'type' => 'string', 'example' => '2006-01-02T15:04:05Z', 'title' => ''], 'ReserveSet' => [ - 'description' => 'Reserved resource list.'."\n", + 'description' => 'The list of reserved resources.', 'type' => 'array', 'items' => [ - 'description' => 'The reserved region object.'."\n", + 'description' => 'The reserved region object.', 'type' => 'object', 'properties' => [ - 'Region' => [ - 'description' => 'Information about the region. The Chinese mainland supports the input of regions and special administrative regions, and the regions outside the Chinese mainland support the input of countries. The following is the corresponding parameter mapping:'."\n" - ."\n" - .'Chinese mainland:'."\n" - ."\n" - .'* East China: huadong'."\n" - .'* South China: huanan'."\n" - .'* Central China: huazhong'."\n" - .'* North China: huabei'."\n" - .'* Northwest China: xibei'."\n" - .'* Southwest China: xinan'."\n" - .'* Northeast China: dongbei'."\n" - ."\n" - .'Special Administrative Regions and overseas:'."\n" - ."\n" - .'* Taiwan, China: tw'."\n" - .'* Macau, China: mo'."\n" - .'* Hong Kong, China: hk'."\n" - .'* Japan: jp'."\n" - .'* United States: us'."\n" - .'* Thailand: th'."\n" - .'* Korea: kr'."\n" - .'* Russia: ru'."\n" - .'* Singapore: sg'."\n" - .'* France: fr'."\n" - .'* Spain: es'."\n" - .'* Italy: it'."\n" - .'* Sweden: se'."\n" - .'* UAE: ae'."\n" - .'* Indonesia: id'."\n" - .'* Chile: cl'."\n" - .'* Philippines: ph'."\n" - .'* Malaysia: my'."\n" - .'* Vietnam: vn'."\n" - .'* Argentina: AR'."\n" - .'* Australia: au'."\n" - .'* Brazil: br'."\n" - .'* Colombia: co'."\n" - .'* Germany: de'."\n" - .'* UK: GB'."\n" - .'* Peru: pe'."\n" - .'* Saudi Arabia: sa'."\n" - .'* Netherlands: nl'."\n" - .'* South Africa: za'."\n", - 'type' => 'string', - 'example' => 'huazhong', - 'title' => '', - ], - 'Isp' => [ - 'description' => 'The ISP. The following types are supported. You do not need to enter the ISP in regions outside the Chinese mainland:'."\n" - ."\n" - .'* China Mobile: cmcc'."\n" - .'* China Telecom: chinanet'."\n" - .'* China Unicom: unicom'."\n", - 'type' => 'string', - 'example' => 'cmcc', - 'title' => '', - ], - 'Replicas' => [ - 'description' => 'The number of container replicas.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], + 'Region' => ['description' => 'The region information. For the Chinese mainland, you can specify a major region. For special administrative regions and areas outside China, you can specify a country or region. The following list shows the parameter mappings:'."\n" + ."\n" + .'Chinese mainland:'."\n" + ."\n" + .'- East China: huadong'."\n" + .'- South China: huanan'."\n" + .'- Central China: huazhong'."\n" + .'- North China: huabei'."\n" + .'- Northwest China: xibei'."\n" + .'- Southwest China: xinan'."\n" + .'- Northeast China: dongbei'."\n" + ."\n" + .'Special administrative regions and outside China:'."\n" + .'- Taiwan (China): tw'."\n" + .'- Macao (China): mo'."\n" + .'- Hong Kong (China): hk'."\n" + .'- Japan: jp'."\n" + .'- United States: us'."\n" + .'- Thailand: th'."\n" + .'- South Korea: kr'."\n" + .'- Russia: ru'."\n" + .'- Singapore: sg'."\n" + .'- France: fr'."\n" + .'- Spain: es'."\n" + .'- Italy: it'."\n" + .'- Sweden: se'."\n" + .'- United Arab Emirates: ae'."\n" + .'- Indonesia: id'."\n" + .'- Chile: cl'."\n" + .'- Philippines: ph'."\n" + .'- Malaysia: my'."\n" + .'- Vietnam: vn'."\n" + .'- Argentina: ar'."\n" + .'- Australia: au'."\n" + .'- Brazil: br'."\n" + .'- Colombia: co'."\n" + .'- Germany: de'."\n" + .'- United Kingdom: gb'."\n" + .'- Peru: pe'."\n" + .'- Saudi Arabia: sa'."\n" + .'- Netherlands: nl'."\n" + .'- South Africa: za.', 'type' => 'string', 'example' => 'huazhong', 'title' => ''], + 'Isp' => ['description' => 'The Internet service provider (ISP). The following ISPs are supported. You do not need to specify an ISP for special administrative regions or areas outside China:'."\n" + ."\n" + .'- China Mobile: cmcc'."\n" + .'- China Telecom: chinanet'."\n" + .'- China Unicom: unicom.', 'type' => 'string', 'example' => 'cmcc', 'title' => ''], + 'Replicas' => ['description' => 'The number of container replicas.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', @@ -82583,72 +46738,30 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', - 'description' => 'Invalid parameter. Check the parameter configuration.', - ], - [ - 'errorCode' => 'InvalidParameter.Appid', - 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', - 'description' => 'The format of the input application ID is incorrect. You can use the ListEdgeContainerApps API to obtain the application ID.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', 'description' => 'Invalid parameter. Check the parameter configuration.'], + ['errorCode' => 'InvalidParameter.Appid', 'errorMessage' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.', 'description' => 'The format of the input application ID is incorrect. You can use the ListEdgeContainerApps API to obtain the application ID.'], ], 404 => [ - [ - 'errorCode' => 'InvalidApp.NotFound', - 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], + ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', 'description' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], '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"}]', - 'title' => 'UpdateEdgeContainerAppResourceReserve', + 'title' => 'Update edge container application resource reservation configuration', '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEdgeContainerAppResourceReserve'], ], ], + 'ramActions' => [], ], 'UpdateHttpIncomingRequestHeaderModificationRule' => [ - 'summary' => 'Updates the HTTP incoming request header modification rule.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Modify HTTP incoming request header configuration.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -82661,60 +46774,35 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257647', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '568181195163328', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '568181195163328', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration ID. You can call the ListHttpIncomingRequestHeaderModificationRules operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '419717024278528', - 'title' => '', - ], + 'schema' => ['description' => 'Configuration ID. Can be obtained by calling the ListHttpIncomingRequestHeaderModificationRules API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '419717024278528', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'The rule name. You do not need to set this parameter when you add global configurations.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - 'title' => '', - ], + 'schema' => ['description' => 'Rule name. This parameter does not need to be set when adding a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configurations. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", + 'description' => 'Rule switch. This parameter does not need to be set when adding a global configuration. Valid values:'."\n" + .'- on: Enable.'."\n" + .'- off: Disable.', + 'enumValueTitles' => ['off' => 'Disable', 'on' => 'Enable'], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, - 'enum' => [ - 'on', - 'off', - ], 'example' => 'on', 'title' => '', ], @@ -82722,69 +46810,44 @@ [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configurations. Use cases:'."\n" - ."\n" - .'* true: Match all incoming requests.'."\n" - .'* Set the value to a custom expression, for example, (http.host eq "video.example.com"): Match the specified request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], + 'schema' => ['description' => 'Rule content, using conditional expressions to match user requests. This parameter does not need to be set when adding a global configuration. There are two usage scenarios:'."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + .'- Match specified requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', 'type' => 'string', 'required' => false, 'example' => '(http.host eq "video.example.com")', 'title' => ''], ], [ 'name' => 'RequestHeaderModification', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The configurations of modifying request headers. You can add, delete, or modify a request header.'."\n", + 'description' => 'Modify request headers. Three operation types are supported: add, delete, and modify.', 'type' => 'array', 'items' => [ - 'description' => 'The configuration of modifying a request header.'."\n", + 'description' => 'Request header modification details.', 'type' => 'object', 'properties' => [ 'Operation' => [ - 'description' => 'The action. Valid values:'."\n" + 'description' => 'Operation type. Valid values:'."\n" ."\n" - .'* add: adds a response header.'."\n" - .'* del: deletes a response header.'."\n" - .'* modify: modifies a response header.'."\n", + .'- add: Add.'."\n" + .'- del: Delete.'."\n" + .'- modify: Modify.', + 'enumValueTitles' => ['add' => 'Add', 'modify' => 'Modify', 'del' => 'Delete'], 'type' => 'string', 'required' => true, - 'enum' => [ - 'add', - 'modify', - 'del', - ], + 'enum' => ['add', 'modify', 'del'], 'example' => 'add', 'title' => '', ], - 'Name' => [ - 'description' => 'The name of the request header.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'headerName', - 'title' => '', - ], - 'Value' => [ - 'description' => 'The value of the request header.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'headerValue', - 'title' => '', - ], + 'Name' => ['description' => 'Request header name.', 'type' => 'string', 'required' => true, 'example' => 'headerName', 'title' => ''], + 'Value' => ['description' => 'Request header value.', 'type' => 'string', 'required' => false, 'example' => 'headerValue', 'title' => ''], 'Type' => [ - 'description' => 'The value type. Valid values:'."\n" - ."\n" - .'* static'."\n" - .'* dynamic'."\n", + 'description' => 'Value type. Valid values:'."\n" + .'- static: Static mode.'."\n" + .'- dynamic: Dynamic mode.', + 'enumValueTitles' => ['static' => 'Static mode', 'dynamic' => 'Dynamic mode'], 'type' => 'string', + 'enum' => ['static', 'dynamic'], 'required' => false, - 'enum' => [ - 'static', - 'dynamic', - ], 'example' => 'static', 'title' => '', ], @@ -82801,29 +46864,17 @@ [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'The order in which the rule is executed. A smaller value gives priority to the rule.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'Rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Request response result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'BFEF3861-8BB7-5B63-954C-6575EA7FB2CA', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'BFEF3861-8BB7-5B63-954C-6575EA7FB2CA'], ], 'example' => '', ], @@ -82831,176 +46882,66 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'VerifyExpressionError', - 'errorMessage' => 'Dynamic expression is invalid.', - 'description' => 'Dynamic expression is invalid.', - ], - [ - 'errorCode' => 'InvalidValOfDelHeader', - 'errorMessage' => 'The delete header operation does not support setting value.', - 'description' => 'The delete header operation does not support setting value.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => '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.'], + ['errorCode' => 'VerifyExpressionError', 'errorMessage' => 'Dynamic expression is invalid.', 'description' => 'Dynamic expression is invalid.'], + ['errorCode' => 'InvalidValOfDelHeader', 'errorMessage' => 'The delete header operation does not support setting value.', 'description' => 'The delete header operation does not support setting value.'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'UpdateHttpIncomingRequestHeaderModificationRule', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BFEF3861-8BB7-5B63-954C-6575EA7FB2CA\\"\\n}","type":"json"}]', + 'title' => 'Update HTTP Incoming Request Header Modification Configuration', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateHttpIncomingRequestHeaderModificationRule'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateHttpIncomingRequestHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], + ], + ], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BFEF3861-8BB7-5B63-954C-6575EA7FB2CA\\"\\n}","type":"json"}]', ], 'UpdateHttpIncomingResponseHeaderModificationRule' => [ - 'summary' => 'Updates the configuration of modifying HTTP response headers for a website.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Updates the HTTP incoming response header modification configuration for a site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -83013,60 +46954,36 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257652', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '498607398028944', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '498607398028944', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the configuration. You can call the ListHttpIncomingResponseHeaderModificationRules operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '352816096987136', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID. You can call the ListHttpIncomingResponseHeaderModificationRules operation to obtain the configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '352816096987136', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'The rule name. You do not need to set this parameter when you add global configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. This parameter is not required when adding a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Valid values:'."\n" + 'description' => 'The rule switch. This parameter is not required when adding a global configuration. Valid values:'."\n" ."\n" - .'* on'."\n" - .'* off'."\n", + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'off', 'on' => 'on'], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, - 'enum' => [ - 'on', - 'off', - ], 'example' => 'on', 'title' => '', ], @@ -83074,69 +46991,44 @@ [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:'."\n" - ."\n" - .'* true: Match all incoming requests.'."\n" - .'* Set the value to a custom expression, for example, (http.host eq "video.example.com"): Match the specified request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], + 'schema' => ['description' => 'The rule content, which uses a conditional expression to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + .'- Match specified requests: Set the value to a custom expression, for example, (http.host eq \\"video.example.com\\").', 'type' => 'string', 'required' => false, 'example' => '(http.host eq "video.example.com")', 'title' => ''], ], [ 'name' => 'ResponseHeaderModification', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'Modifies a response header. You can add, delete, or modify a request header.'."\n", + 'description' => 'The response header modifications. Three operation types are supported: add, delete, and modify.', 'type' => 'array', 'items' => [ - 'description' => 'The configuration of modifying a response header.'."\n", + 'description' => 'The response header modification details.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the response header.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'headerName', - 'title' => '', - ], + 'Name' => ['description' => 'The response header name.', 'type' => 'string', 'required' => true, 'example' => 'headerName', 'title' => ''], 'Operation' => [ - 'description' => 'The action. Valid values:'."\n" + 'description' => 'The operation type. Valid values:'."\n" ."\n" - .'* add: adds a response header.'."\n" - .'* del: deletes a response header.'."\n" - .'* modify: modifies a response header.'."\n", + .'- add: Add.'."\n" + .'- del: Delete.'."\n" + .'- modify: Modify.', + 'enumValueTitles' => ['add' => 'add', 'modify' => 'modify', 'del' => 'del'], 'type' => 'string', 'required' => true, - 'enum' => [ - 'add', - 'modify', - 'del', - ], + 'enum' => ['add', 'modify', 'del'], 'example' => 'add', 'title' => '', ], - 'Value' => [ - 'description' => 'The value of the response header.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'headerValue', - 'title' => '', - ], + 'Value' => ['description' => 'The response header value.', 'type' => 'string', 'required' => false, 'example' => 'headerValue', 'title' => ''], 'Type' => [ - 'description' => 'The value type of the column. Valid values:'."\n" - ."\n" - .'* static'."\n" - .'* dynamic'."\n", + 'description' => 'The value type. Valid values:'."\n" + .'- static: Static pattern.'."\n" + .'- dynamic: Dynamic schema.', + 'enumValueTitles' => ['static' => 'static', 'dynamic' => 'dynamic'], 'type' => 'string', + 'enum' => ['static', 'dynamic'], 'required' => false, - 'enum' => [ - 'static', - 'dynamic', - ], 'example' => 'static', 'title' => '', ], @@ -83153,29 +47045,17 @@ [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'The order in which the rule is executed. A smaller value gives priority to the rule.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74'], ], 'example' => '', ], @@ -83183,176 +47063,66 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'VerifyExpressionError', - 'errorMessage' => 'Dynamic expression is invalid.', - 'description' => 'Dynamic expression is invalid.', - ], - [ - 'errorCode' => 'InvalidValOfDelHeader', - 'errorMessage' => 'The delete header operation does not support setting value.', - 'description' => 'The delete header operation does not support setting value.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => '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.'], + ['errorCode' => 'VerifyExpressionError', 'errorMessage' => 'Dynamic expression is invalid.', 'description' => 'Dynamic expression is invalid.'], + ['errorCode' => 'InvalidValOfDelHeader', 'errorMessage' => 'The delete header operation does not support setting value.', 'description' => 'The delete header operation does not support setting value.'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'UpdateHttpIncomingResponseHeaderModificationRule', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', + 'title' => 'Update HTTP incoming response header modification configuration', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateHttpIncomingResponseHeaderModificationRule'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateHttpIncomingResponseHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], + ], + ], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', ], 'UpdateHttpRequestHeaderModificationRule' => [ - 'summary' => 'Modify HTTP Request Header Rules', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Modify HTTP request header rules.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -83365,126 +47135,79 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257647', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID. It can be obtained by calling the [ListHttpRequestHeaderModificationRules](~~2867483~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'Configuration ID. You can call the [ListHttpRequestHeaderModificationRules](~~2867483~~) operation to obtain the configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '35281609698****', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - 'title' => '', - ], + 'schema' => ['description' => 'Rule name. This parameter is not required when adding a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Possible values:'."\n" + 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Valid values:'."\n" .'- on: Enable.'."\n" .'- off: Disable.', + 'enumValueTitles' => ['off' => 'Disable', 'on' => 'Enable'], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- To match all incoming requests: Set the value to true'."\n" - .'- To match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], + 'schema' => ['description' => 'Rule content. Use conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + .'- Match specified requests: Set the value to a custom expression, for example: (http.host eq "video.example.com").', 'type' => 'string', 'required' => false, 'example' => '(http.host eq "video.example.com")', 'title' => ''], ], [ 'name' => 'RequestHeaderModification', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'Modify request headers, supporting add, delete, and modify operations.', + 'description' => 'Modify request headers. Three operation methods are supported: add, delete, and modify.', 'type' => 'array', 'items' => [ - 'description' => 'Details of modifying request headers.', + 'description' => 'Details of request header modification.', 'type' => 'object', 'properties' => [ 'Operation' => [ - 'description' => 'Operation method. Possible values:'."\n" + 'description' => 'Operation method. Valid values:'."\n" ."\n" .'- add: Add.'."\n" - .'- del: Delete'."\n" + .'- del: Delete.'."\n" .'- modify: Modify.', + 'enumValueTitles' => ['add' => 'Add', 'modify' => 'Modify', 'del' => 'Delete'], 'type' => 'string', 'required' => true, + 'enum' => ['add', 'modify', 'del'], 'example' => 'add', - 'enum' => [ - 'add', - 'modify', - 'del', - ], - 'title' => '', - ], - 'Name' => [ - 'description' => 'Request header name.', - 'type' => 'string', - 'required' => true, - 'example' => 'headerName', - 'title' => '', - ], - 'Value' => [ - 'description' => 'Request header value.', - 'type' => 'string', - 'required' => false, - 'example' => 'headerValue', 'title' => '', ], + 'Name' => ['description' => 'Request header name.', 'type' => 'string', 'required' => true, 'example' => 'headerName', 'title' => ''], + 'Value' => ['description' => 'Request header value.', 'type' => 'string', 'required' => false, 'example' => 'headerValue', 'title' => ''], 'Type' => [ - 'description' => 'Value Type. Valid values: '."\n" - .'- static: Static mode. '."\n" - .'- dynamic: Dynamic mode. ', + 'description' => 'Value type. Valid values:'."\n" + .'- static: Static mode.'."\n" + .'- dynamic: Dynamic mode.', + 'enumValueTitles' => ['static' => 'Static mode', 'dynamic' => 'Dynamic mode'], 'type' => 'string', - 'enum' => [ - 'static', - 'dynamic', - ], + 'enum' => ['static', 'dynamic'], 'required' => false, 'example' => 'static', 'title' => '', @@ -83502,29 +47225,17 @@ [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule execution order. Rules with smaller numeric values are executed first. ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'Rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Request response result.', + 'title' => '', + 'description' => 'Response result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '2430E05E-1340-5773-B5E1-B743929F46F2', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '2430E05E-1340-5773-B5E1-B743929F46F2'], ], 'example' => '', ], @@ -83532,196 +47243,70 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'VerifyExpressionError', - 'errorMessage' => 'Dynamic expression is invalid.', - 'description' => 'Dynamic expression is invalid.', - ], - [ - 'errorCode' => 'InvalidValOfDelHeader', - 'errorMessage' => 'The delete header operation does not support setting value.', - 'description' => 'The delete header operation does not support setting 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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => '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.'], + ['errorCode' => 'VerifyExpressionError', 'errorMessage' => 'Dynamic expression is invalid.', 'description' => 'Dynamic expression is invalid.'], + ['errorCode' => 'InvalidValOfDelHeader', 'errorMessage' => 'The delete header operation does not support setting value.', 'description' => 'The delete header operation does not support setting 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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'Update HTTP Request Header Configuration', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2430E05E-1340-5773-B5E1-B743929F46F2\\"\\n}","type":"json"}]', + 'title' => 'Update HTTP Request Header Modification Configuration', 'changeSet' => [ - [ - 'createdAt' => '2025-04-10T07:02:38.000Z', - 'description' => 'Error codes changed, Request parameters changed', - ], - [ - 'createdAt' => '2025-03-27T02:58:48.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-04-10T07:02:38.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2025-03-27T02:58:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateHttpRequestHeaderModificationRule', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateHttpRequestHeaderModificationRule'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateHttpRequestHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2430E05E-1340-5773-B5E1-B743929F46F2\\"\\n}","type":"json"}]', ], 'UpdateHttpResponseHeaderModificationRule' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Updates the HTTP response header modification configuration for a site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -83734,125 +47319,79 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257652', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456******', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456******', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID. It can be obtained by calling the [ListHttpResponseHeaderModificationRules](~~2867483~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID. You can call the [ListHttpResponseHeaderModificationRules](~~2867483~~) operation to obtain the configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '35281609698****', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. This parameter is not required when you add a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', + 'description' => 'Specifies whether to enable the rule. This parameter is not required when you add a global configuration. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', + 'enumValueTitles' => ['off' => 'off', 'on' => 'on'], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], + 'schema' => ['description' => 'The rule content, which uses a conditional expression to match user requests. This parameter is not required when you add a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + .'- Match specified requests: Set the value to a custom expression, such as (http.host eq \\"video.example.com\\").', 'type' => 'string', 'required' => false, 'example' => '(http.host eq "video.example.com")', 'title' => ''], ], [ 'name' => 'ResponseHeaderModification', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'Modify response headers, supporting three operation methods: add, delete, and modify.', + 'description' => 'The response header modifications. Three operation types are supported: add, delete, and modify.', 'type' => 'array', 'items' => [ - 'description' => 'Details of modifying response headers.', + 'description' => 'The response header modification details.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'Response header name.', - 'type' => 'string', - 'required' => true, - 'example' => 'headerName', - 'title' => '', - ], + 'Name' => ['description' => 'The response header name.', 'type' => 'string', 'required' => true, 'example' => 'headerName', 'title' => ''], 'Operation' => [ - 'description' => 'Operation method. Value range:'."\n" - .'- add: Add.'."\n" - .'- del: Delete'."\n" - .'- modify: Modify.', + 'description' => 'The operation type. Valid values:'."\n" + ."\n" + .'- add: adds a response header.'."\n" + .'- del: deletes a response header.'."\n" + .'- modify: modifies a response header.', + 'enumValueTitles' => ['add' => 'add', 'modify' => 'modify', 'del' => 'del'], 'type' => 'string', 'required' => true, + 'enum' => ['add', 'modify', 'del'], 'example' => 'add', - 'enum' => [ - 'add', - 'modify', - 'del', - ], - 'title' => '', - ], - 'Value' => [ - 'description' => 'Response header value.', - 'type' => 'string', - 'required' => false, - 'example' => 'headerValue', 'title' => '', ], + 'Value' => ['description' => 'The response header value.', 'type' => 'string', 'required' => false, 'example' => 'headerValue', 'title' => ''], 'Type' => [ - 'description' => 'Value Type. Valid values:'."\n" - .'- static: Static mode.'."\n" - .'- dynamic: Dynamic mode.', + 'description' => 'The value type. Valid values:'."\n" + .'- static: static pattern.'."\n" + .'- dynamic: dynamic schema.', + 'enumValueTitles' => ['static' => 'static', 'dynamic' => 'dynamic'], 'type' => 'string', - 'enum' => [ - 'static', - 'dynamic', - ], + 'enum' => ['static', 'dynamic'], 'required' => false, 'example' => 'static', 'title' => '', @@ -83870,29 +47409,17 @@ [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule execution order. Rules with smaller Numeric values are executed first. ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Request response result.', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE'], ], 'example' => '', ], @@ -83900,198 +47427,69 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'VerifyExpressionError', - 'errorMessage' => 'Dynamic expression is invalid.', - 'description' => 'Dynamic expression is invalid.', - ], - [ - 'errorCode' => 'InvalidValOfDelHeader', - 'errorMessage' => 'The delete header operation does not support setting value.', - 'description' => 'The delete header operation does not support setting 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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => '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.'], + ['errorCode' => 'VerifyExpressionError', 'errorMessage' => 'Dynamic expression is invalid.', 'description' => 'Dynamic expression is invalid.'], + ['errorCode' => 'InvalidValOfDelHeader', 'errorMessage' => 'The delete header operation does not support setting value.', 'description' => 'The delete header operation does not support setting 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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'Update HTTP Response Header Configuration', - 'summary' => 'Modify HTTP response header rules', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\"\\n}","type":"json"}]', + 'title' => 'Update HTTP response header modification configuration', 'changeSet' => [ - [ - 'createdAt' => '2025-04-10T07:02:39.000Z', - 'description' => 'Error codes changed, Request parameters changed', - ], - [ - 'createdAt' => '2025-03-27T02:58:48.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-04-10T07:02:39.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2025-03-27T02:58:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateHttpResponseHeaderModificationRule', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateHttpResponseHeaderModificationRule'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateHttpResponseHeaderModificationRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-280B-72F8FD6DA2FE\\"\\n}","type":"json"}]', ], 'UpdateHttpsApplicationConfiguration' => [ - 'summary' => 'Modify HTTPS Application Configuration', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -84104,263 +47502,165 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257969', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. To obtain this ID, call the [ListSites](~~ListSites~~) API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '35281609698****', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. This parameter is not required for a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Value range:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable the rule. This parameter is not required for a global configuration. Valid values:'."\n" + ."\n" + .'- `on`: Enables the rule.'."\n" + ."\n" + .'- `off`: Disables the rule.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq \\"video.example.com\\")', - 'title' => '', - ], + 'schema' => ['description' => 'The conditional expression that the rule uses to match requests. This parameter is not required for a global configuration.'."\n" + ."\n" + .'- To match all incoming requests, set the value to `true`.'."\n" + ."\n" + .'- To match specific requests, provide a custom expression, such as `(http.host eq "video.example.com")`', 'type' => 'string', 'required' => false, 'example' => '(http.host eq \\"video.example.com\\")', 'title' => ''], ], [ 'name' => 'HttpsForce', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable forced HTTPS, default is disabled. Value range:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable Force HTTPS. This feature is disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: Enables Force HTTPS.'."\n" + ."\n" + .'- `off`: Disables Force HTTPS.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'HttpsForceCode', 'in' => 'query', - 'schema' => [ - 'description' => 'Forced HTTPS redirect status code, value range:'."\n" - .'- 301'."\n" - .'- 302'."\n" - .'- 307'."\n" - .'- 308', - 'type' => 'string', - 'required' => false, - 'example' => '301', - 'title' => '', - ], + 'schema' => ['description' => 'The redirect status code for Force HTTPS. Valid values:'."\n" + ."\n" + .'- `301`'."\n" + ."\n" + .'- `302`'."\n" + ."\n" + .'- `307`'."\n" + ."\n" + .'- `308`', 'type' => 'string', 'required' => false, 'example' => '301', 'title' => ''], ], [ 'name' => 'AltSvc', 'in' => 'query', - 'schema' => [ - 'description' => 'Feature switch, default is disabled. Value range:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable the `Alt-Svc` header. This feature is disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: Enables the Alt-Svc header.'."\n" + ."\n" + .'- `off`: Disables the Alt-Svc header.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'AltSvcClear', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether the Alt-Svc header includes the clear parameter, default is disabled. Value range:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to include the `clear` directive in the `Alt-Svc` header. The directive is not included by default. Valid values:'."\n" + ."\n" + .'- `on`: Includes the directive.'."\n" + ."\n" + .'- `off`: Does not include the directive.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'AltSvcPersist', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether the Alt-Svc header includes the persist parameter, default is disabled. Value range:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to include the `persist` directive in the `Alt-Svc` header. The directive is not included by default. Valid values:'."\n" + ."\n" + .'- `on`: Includes the directive.'."\n" + ."\n" + .'- `off`: Does not include the directive.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'AltSvcMa', 'in' => 'query', - 'schema' => [ - 'description' => 'Alt-Svc validity period, in seconds, default is 86400 seconds.', - 'type' => 'string', - 'required' => false, - 'example' => '86400', - 'title' => '', - ], + 'schema' => ['description' => 'The max-age for the Alt-Svc header, in seconds. The default is 86400.', 'type' => 'string', 'required' => false, 'example' => '86400', 'title' => ''], ], [ 'name' => 'Hsts', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable HSTS, default is disabled. Value range:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable HTTP Strict Transport Security (HSTS). This feature is disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: Enables HSTS.'."\n" + ."\n" + .'- `off`: Disables HSTS.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'HstsMaxAge', 'in' => 'query', - 'schema' => [ - 'description' => 'HSTS expiration time, in seconds.', - 'type' => 'string', - 'required' => false, - 'example' => '3600', - 'title' => '', - ], + 'schema' => ['description' => 'The HSTS max-age in seconds.', 'type' => 'string', 'required' => false, 'example' => '3600', 'title' => ''], ], [ 'name' => 'HstsIncludeSubdomains', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to include subdomains in HSTS, default is disabled. Value range:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to include subdomains in the HSTS policy. Subdomains are not included by default. Valid values:'."\n" + ."\n" + .'- `on`: Includes subdomains.'."\n" + ."\n" + .'- `off`: Does not include subdomains.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'HstsPreload', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable HSTS preload, default is disabled. Value range:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable HSTS Preload. HSTS Preload is disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: Enables Preload.'."\n" + ."\n" + .'- `off`: Disables Preload.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule execution order. Rules with smaller values are executed first.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The execution order of the rule. A lower value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'HttpsSniVerify', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable SNI validation. By default, it is disabled. Valid values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable Server Name Indication (SNI) verification. This feature is disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: Enables SNI verification.'."\n" + ."\n" + .'- `off`: Disables SNI verification.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'HttpsNoSniDeny', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to deny TLS handshake requests without Server Name Indication (SNI). Disabled by default. Valid values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to deny TLS handshake requests that do not include an SNI. This feature is disabled by default. Valid values:'."\n" + ."\n" + .'- `on`: Denies requests without an SNI.'."\n" + ."\n" + .'- `off`: Allows requests without an SNI.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'HttpsSniWhitelist', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies the whitelist of allowed SNI entries, separated by spaces.', - 'type' => 'string', - 'required' => false, - 'example' => 'abc edf', - 'title' => '', - ], + 'schema' => ['description' => 'The SNI allowlist. Separate multiple hostnames with spaces.', 'type' => 'string', 'required' => false, 'example' => 'abc edf', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '35C66C7B-671H-4297-9187-2C4477247A78', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '35C66C7B-671H-4297-9187-2C4477247A78'], ], 'example' => '', ], @@ -84368,177 +47668,66 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], 'title' => 'Modify Site HTTPS Application Configuration', + 'summary' => 'Update the HTTPS Application Configuration.', 'changeSet' => [ - [ - 'createdAt' => '2025-06-03T07:09:13.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2025-03-27T02:58:48.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-06-03T07:09:13.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-27T02:58:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateHttpsApplicationConfiguration', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateHttpsApplicationConfiguration'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateHttpsApplicationConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"35C66C7B-671H-4297-9187-2C4477247A78\\"\\n}","type":"json"}]', ], 'UpdateHttpsBasicConfiguration' => [ - 'summary' => 'Modify HTTPS Basic Configuration', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -84551,227 +47740,144 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257970', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1231231221****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1231231221****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '3528160969****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '3528160969****', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. This parameter is not required when you add a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Indicates whether the rule is enabled. This parameter is not required when you add a global configuration. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq \\"video.example.com\\")'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The conditional expression used to match incoming requests. This parameter is not required when you add a global configuration. Use cases:'."\n" + ."\n" + .'- To match all incoming requests, set the value to `true`.'."\n" + ."\n" + .'- To match specific requests, set the value to a custom expression, for example, `(http.host eq "video.example.com")`.', 'type' => 'string', 'required' => false, 'example' => '(http.host eq \\"video.example.com\\")'."\n", 'title' => ''], ], [ 'name' => 'Https', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable HTTPS. Default is enabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Indicates whether HTTPS is enabled. Default value: `on`. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Tls10', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable TLS1.0. Default is disabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Indicates whether TLS 1.0 is enabled. Default value: `off`. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Tls11', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable TLS1.1. Default is disabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Indicates whether TLS 1.1 is enabled. Default value: `off`. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Tls12', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable TLS1.2. Default is disabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Indicates whether TLS 1.2 is enabled. Default value: `off`. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Tls13', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable TLS1.3. Default is disabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Indicates whether TLS 1.3 is enabled. Default value: `off`. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'CiphersuiteGroup', 'in' => 'query', - 'schema' => [ - 'description' => 'Cipher suite group. Default is all cipher suites. Value range:'."\n" - .'- all: All cipher suites.'."\n" - .'- strict: Strong cipher suites.'."\n" - .'- custom: Custom cipher suites.', - 'type' => 'string', - 'required' => false, - 'example' => 'all', - 'title' => '', - ], + 'schema' => ['description' => 'The cipher suite group. Default value: `all`. Valid values:'."\n" + ."\n" + .'- `all`: All cipher suites.'."\n" + ."\n" + .'- `strict`: strong cipher suites.'."\n" + ."\n" + .'- `custom`: custom cipher suites.', 'type' => 'string', 'required' => false, 'example' => 'all', 'title' => ''], ], [ 'name' => 'Ciphersuite', 'in' => 'query', - 'schema' => [ - 'description' => 'Custom cipher suite, indicating the specific encryption algorithm selected when CiphersuiteGroup is set to custom.', - 'type' => 'string', - 'required' => false, - 'example' => 'TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256', - 'title' => '', - ], + 'schema' => ['description' => 'The custom cipher suite to use when `CiphersuiteGroup` is set to `custom`.', 'type' => 'string', 'required' => false, 'example' => 'TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256', 'title' => ''], ], [ 'name' => 'OcspStapling', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable OCSP. Default is disabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Indicates whether OCSP stapling is enabled. Default value: `off`. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Http2', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable HTTP2. Default is enabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Indicates whether HTTP/2 is enabled. Default value: `on`. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Http3', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable HTTP3. Default is enabled. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Indicates whether HTTP/3 is enabled. Default value: `on`. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule execution order. A smaller numeric value indicates higher priority.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9'], ], 'example' => '', ], @@ -84779,173 +47885,66 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.Function', - 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', - 'description' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.'], + ['errorCode' => 'QuotaCheckFailed.Function', 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', 'description' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], 'title' => 'Modify Site HTTPS Basic Configuration', + 'summary' => 'Modify Basic HTTPS Configuration.', 'changeSet' => [ - [ - 'createdAt' => '2025-03-27T02:58:48.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-03-27T02:58:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateHttpsBasicConfiguration', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateHttpsBasicConfiguration'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateHttpsBasicConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', ], 'UpdateIPv6' => [ - 'summary' => 'Modify Site IPv6 Configuration', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Modify IPv6 configuration for a website.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -84958,38 +47957,27 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257436', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '5407498413****', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling [ListSites](~~2850189~~).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5407498413****', 'title' => ''], ], [ 'name' => 'Enable', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable IPv6. Valid values:'."\n" + 'description' => 'The switch. Valid values:'."\n" ."\n" - .'* **on**'."\n" - .'* **off**'."\n", + .'- **on**: enabled.'."\n" + .'- **off**: disabled.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', 'required' => true, + 'enum' => ['on', 'off'], 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], @@ -84997,15 +47985,13 @@ 'name' => 'Region', 'in' => 'query', 'schema' => [ - 'description' => 'Area where IPv6 is enabled. Default value: x.x:'."\n" + 'description' => 'The region in which IPv6 is enabled. Default value: x.x.'."\n" ."\n" - .'- x.x: Global.'."\n" - .'- cn.cn: Mainland China.', + .'- x.x: global.'."\n" + .'- cn.cn: Chinese mainland.', + 'enumValueTitles' => ['x.x' => 'Global', 'cn.cn' => 'Chinese mainland'], 'type' => 'string', - 'enum' => [ - 'x.x', - 'cn.cn', - ], + 'enum' => ['x.x', 'cn.cn'], 'required' => false, 'example' => 'x.x', 'title' => '', @@ -85015,16 +48001,11 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74'], ], 'example' => '', ], @@ -85032,155 +48013,44 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => '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.', - ], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => '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.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'Modify Site IPv6 Configuration', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', + 'title' => 'Modify IPv6 configuration for a website', 'changeSet' => [ - [ - 'createdAt' => '2025-03-27T02:33:22.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-03-27T02:33:22.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateIPv6', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIPv6'], ], ], 'ramActions' => [ @@ -85191,25 +48061,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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', - ], + 'summary' => 'Modifies the image transformation configuration of a site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -85222,49 +48083,30 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257354', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID. It can be obtained by calling the [ListImageTransforms](~~2869056~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '352816096987136', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID. You can call the [ListImageTransforms](~~2869056~~) operation to obtain the configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '352816096987136', 'title' => ''], ], [ 'name' => 'Enable', 'in' => 'query', 'schema' => [ - 'description' => 'Indicates whether to enable image transformation. Possible values:'."\n" + 'description' => 'Specifies whether to enable image transformation. Valid values:'."\n" ."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], 'example' => 'on', 'title' => '', ], @@ -85272,27 +48114,18 @@ [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. You do not need to set this parameter when adding a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Possible values:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', + 'description' => 'The rule switch. You do not need to set this parameter when adding a global configuration. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], 'example' => 'on', 'title' => '', ], @@ -85300,42 +48133,34 @@ [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content, used to match user requests with conditional expressions. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- To match all incoming requests: Set the value to true.'."\n" - .'- To match specific requests: Set the value to a custom expression, for example: (http.host eq "video.example.com")', - 'type' => 'string', - 'required' => false, - 'example' => '(http.request.uri.path.file_name eq \\"jpg\\")', - 'title' => '', - ], + 'schema' => ['description' => 'The rule content, which uses a conditional expression to match user requests. You do not need to set this parameter when adding a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + .'- Match specified requests: Set the value to a custom expression, such as (http.host eq \\"video.example.com\\").', 'type' => 'string', 'required' => false, 'example' => '(http.request.uri.path.file_name eq \\"jpg\\")', 'title' => ''], ], [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule execution order. A smaller numeric value indicates higher priority.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The execution order of the rule. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'AutoWebp', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The adaptive WebP setting.', 'type' => 'string', 'example' => 'on', 'required' => false], + ], + [ + 'name' => 'AutoAvif', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The adaptive AVIF setting.', 'type' => 'string', 'example' => 'on', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'], ], 'example' => '', ], @@ -85343,170 +48168,64 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'Modify Site Image Transformation Configuration', - 'summary' => 'Modify Site Image Transformation Configuration', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + 'title' => 'Modify site image transformation configuration', 'changeSet' => [ - [ - 'createdAt' => '2025-03-27T02:58:48.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-03-27T02:58:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateImageTransform', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateImageTransform'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateImageTransform', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', ], 'UpdateList' => [ 'summary' => 'Updates a custom list.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -85519,44 +48238,25 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239583', - 'abilityTreeNodes' => [ - 'FEATUREdcdnL8HX1L', - ], + 'abilityTreeNodes' => ['FEATUREdcdnL8HX1L'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => 'The ID of the custom list, which can be obtained by calling the [ListLists](~~2850217~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '40000001', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the custom list. You can obtain the ID by calling the [ListLists](~~2850217~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '40000001'], ], [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => 'The new name of the list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'example', - ], + 'schema' => ['title' => '', 'description' => 'The new name of the custom list. If this parameter is not specified, the original name is retained.'."\n" + ."\n" + .'**Naming rules**: Only letters, digits, and underscores are supported (`^\\w{1,64}$`). The name must be 1 to 64 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'example'], ], [ 'name' => 'Description', 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => 'The new description of the list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a custom list', - ], + 'schema' => ['title' => '', 'description' => 'The new description of the list.', 'type' => 'string', 'required' => true, 'example' => 'a custom list'], ], [ 'name' => 'Items', @@ -85564,15 +48264,17 @@ 'style' => 'json', 'schema' => [ 'title' => '', - 'description' => 'The items in the updated list. The value is a JSON array.'."\n", + 'description' => 'The new list content. The value is a JSON array string, for example, `["1.1.1.1","2.2.2.2"]`.'."\n" + ."\n" + .'**Full overwrite semantics**: The specified `Items` value completely overwrites the existing list content instead of appending to it.'."\n" + ."\n" + .'> ⚠️ **If this parameter is not specified or is set to an empty value, the existing list content is cleared**. To retain existing items and append new ones, call `GetList` to retrieve the current `Items`, merge them, and then submit the combined list.'."\n" + ."\n" + .'**Element format**: The format depends on the `Kind` value specified when the list was created. UpdateList does not support modifying Kind.'."\n" + .'- Kind = `ip`: Each element must be a valid IP address or CIDR block. If an element is invalid, `WrongValueMatched` is returned.'."\n" + .'- Other Kind values: The element format is subject to the relevant specifications. The number of elements is limited by the tenant quota `NumberItemsPerList`. This limit does not apply to the `ip` Kind.', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'The item in the updated list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10.1.1.1', - ], + 'items' => ['title' => '', 'description' => 'The updated list content item.', 'type' => 'string', 'example' => '10.1.1.1', 'required' => false], 'required' => true, 'example' => 'a custom list', ], @@ -85581,16 +48283,11 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], ], 'example' => '', ], @@ -85598,63 +48295,26 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], 403 => [ - [ - 'errorCode' => '%s.NotSupport', - 'errorMessage' => 'The specified resource type %s is not supported.', - 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.', - ], - [ - 'errorCode' => '%s.OverQuota', - 'errorMessage' => 'The quantity of %s exceeds the quota.', - 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.', - ], - [ - 'errorCode' => '%s.WrongValueMatched', - 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', - 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.', - ], - [ - 'errorCode' => 'List.NotExist', - 'errorMessage' => 'The specified list does not exist.', - 'description' => 'The specified list does not exist.', - ], + ['errorCode' => '%s.NotSupport', 'errorMessage' => 'The specified resource type %s is not supported.', 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.'], + ['errorCode' => '%s.OverQuota', 'errorMessage' => 'The quantity of %s exceeds the quota.', 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.'], + ['errorCode' => '%s.WrongValueMatched', 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.'], + ['errorCode' => 'List.NotExist', 'errorMessage' => 'The specified list does not exist.', 'description' => 'The specified list does not exist.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\"\\n}","type":"json"}]', - 'title' => 'UpdateList', + 'title' => 'Update a custom list', 'changeSet' => [ - [ - 'createdAt' => '2024-09-25T07:02:49.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T09:53:46.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-25T07:02:49.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T09:53:46.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateList', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateList'], ], ], 'ramActions' => [ @@ -85665,25 +48325,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'UpdateLoadBalancer' => [ - 'summary' => 'Modify Load Balancer', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'To modify an existing load balancer, you must specify its load balancer ID.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -85696,25 +48347,21 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238302', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'Enabled', 'in' => 'query', 'schema' => [ - 'description' => 'Whether the load balancer is enabled.'."\n" + 'description' => 'Specifies whether the load balancer is enabled.'."\n" ."\n" - .'- true: Enabled.'."\n" - .'- false: Not enabled.', + .'- `true`: The load balancer is enabled.'."\n" + ."\n" + .'- `false`: The load balancer is disabled.', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], 'example' => 'true', 'title' => '', ], @@ -85722,33 +48369,22 @@ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1159101787****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the Site. You can obtain this ID by calling the [ListSites](~~ListSites~~) API operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1159101787****', 'title' => ''], ], [ 'name' => 'AdaptiveRouting', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'Configuration for fallback across pools.', + 'description' => 'Configures origin-pull behavior across address pools.', 'type' => 'object', 'properties' => [ - 'FailoverAcrossPools' => [ - 'description' => 'Whether to fallback across pools.'."\n" - ."\n" - .'- true: Yes.'."\n" - .'- false: No.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'title' => '', - ], + 'FailoverAcrossPools' => ['description' => 'Specifies whether to perform origin-pull across address pools.'."\n" + ."\n" + .'- `true`: Enables origin-pull across address pools.'."\n" + ."\n" + .'- `false`: Disables origin-pull across address pools.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'OriginLevelRetry' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', @@ -85760,16 +48396,9 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'List of default pool IDs.', + 'description' => 'A list of default address pool IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'Default pool ID, integer type.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '96228666776****', - 'title' => '', - ], + 'items' => ['description' => 'The ID of a default address pool.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '96228666776****', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', @@ -85778,42 +48407,22 @@ [ 'name' => 'FallbackPool', 'in' => 'query', - 'schema' => [ - 'description' => 'Fallback pool ID, where traffic will be directed when all other pools are unavailable.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '96228666776****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the fallback address pool. Traffic is routed to this pool when all other address pools are unavailable.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '96228666776****', 'title' => ''], ], [ 'name' => 'RandomSteering', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'Weighted round-robin configuration, used to control the traffic distribution weights among different pools.', + 'description' => 'The configuration for weighted round-robin. This setting controls the weight of traffic distributed to different address pools.', 'type' => 'object', 'properties' => [ - 'DefaultWeight' => [ - 'description' => 'Default round-robin weight, used for all pools that do not have a separately specified weight. Value range: integers between 0-100.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - 'title' => '', - ], + 'DefaultWeight' => ['description' => 'The default weight applied to all address pools that do not have a specific weight defined. The value must be an integer from 0 to 100, inclusive.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], 'PoolWeights' => [ - 'description' => 'Weight configuration for each backend server pool, where the key is the pool ID and the value is the weight factor. The weight factor represents the proportion of relative traffic distribution.', + 'description' => 'A map of pool IDs to their corresponding weights. These weights determine the proportion of traffic routed to each backend server pool.', 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - 'description' => 'Weight of a single origin pool, a number between 0-100, where 0 indicates no traffic should be routed to this pool.', - 'title' => '', - ], + 'additionalProperties' => ['description' => 'The weight for a single origin pool. The value must be an integer from 0 to 100, inclusive. A value of 0 indicates that no traffic is routed to this pool.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], 'title' => '', 'example' => '', ], @@ -85829,140 +48438,84 @@ 'allowEmptyValue' => false, 'style' => 'json', 'schema' => [ - 'description' => 'Rule configuration list, used to define behavior overrides under specific conditions.', + 'description' => 'A list of rules that define behavior overrides for specific conditions.', 'type' => 'array', 'items' => [ - 'description' => 'Rule information.', + 'description' => 'The configuration of a single rule.', 'type' => 'object', 'properties' => [ - 'RuleName' => [ - 'description' => 'Rule name. This parameter does not need to be set when adding global configurations.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_1', - 'title' => '', - ], - 'Rule' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter does not need to be set when adding global configurations. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, e.g., (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'required' => false, - 'example' => 'http.request.method eq "GET" ', - 'title' => '', - ], - 'RuleEnable' => [ - 'description' => 'Rule switch. This parameter does not need to be set when adding global configurations. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'RuleName' => ['description' => 'The name of the rule. This parameter is not required when you configure global settings.', 'type' => 'string', 'required' => false, 'example' => 'rule_1', 'title' => ''], + 'Rule' => ['description' => 'The content of the rule, specified as a conditional expression to match user requests. This parameter is not required when you configure global settings. Use cases:'."\n" + ."\n" + .'- To match all incoming requests, set the value to `true`.'."\n" + ."\n" + .'- To match specific requests, set the value to a custom expression, such as `(http.host eq "video.example.com")`.', 'type' => 'string', 'required' => false, 'example' => 'http.request.method eq "GET" ', 'title' => ''], + 'RuleEnable' => ['description' => 'Specifies whether the rule is enabled. This parameter is not required when you configure global settings. Valid values:'."\n" + ."\n" + .'- `on`: Enabled.'."\n" + ."\n" + .'- `off`: Disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], 'FixedResponse' => [ - 'description' => 'Execute a specified response after matching the rule.', + 'description' => 'The fixed response to return when the rule\'s condition is met.', 'type' => 'object', 'properties' => [ - 'ContentType' => [ - 'description' => 'Content-Type field in the HTTP Header.', - 'type' => 'string', - 'required' => false, - 'example' => 'application/json', - 'title' => '', - ], - 'Location' => [ - 'description' => 'Location field in the HTTP response.', - 'type' => 'string', - 'required' => false, - 'example' => 'http://www.example.com/index.html'."\n", - 'title' => '', - ], - 'MessageBody' => [ - 'description' => 'Response body value.', - 'type' => 'string', - 'required' => false, - 'example' => 'Hello World!'."\n", - 'title' => '', - ], - 'StatusCode' => [ - 'description' => 'Response status code.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '200', - 'title' => '', - ], + 'ContentType' => ['description' => 'The value of the `Content-Type` field in the HTTP response header.', 'type' => 'string', 'required' => false, 'example' => 'application/json', 'title' => ''], + 'Location' => ['description' => 'The value of the `Location` field in the HTTP response header. This is typically used for redirections.', 'type' => 'string', 'required' => false, 'example' => 'http://www.example.com/index.html'."\n", 'title' => ''], + 'MessageBody' => ['description' => 'The content of the response body.', 'type' => 'string', 'required' => false, 'example' => 'Hello World!'."\n", 'title' => ''], + 'StatusCode' => ['description' => 'The HTTP status code of the response.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], - 'Overrides' => [ - 'description' => 'Modify the corresponding load balancing configuration after matching the rule. The fields in the configuration will override the corresponding fields in the load balancer configuration.', - '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" - .' }', - 'title' => '', - ], - 'Sequence' => [ - 'description' => 'The execution order of the rule. It can be left blank, in which case the rules will be executed in the order they appear in the list. If specified, it must be a positive integer, with higher values indicating higher priority.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], - 'Terminates' => [ - 'description' => 'Whether to terminate the execution of subsequent rules.'."\n" - .'- true: Yes.'."\n" - .'- false: No, default value.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], + 'Overrides' => ['description' => 'The settings to override for requests that match this rule\'s condition. These settings take precedence over the load balancer\'s main configuration.', '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" + .' }', 'title' => ''], + 'Sequence' => ['description' => 'The execution priority of the rule. This parameter is optional. If you do not specify this parameter, rules are executed in the order they are listed. If specified, the value must be an integer greater than 0. A larger value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'Terminates' => ['description' => 'Specifies whether to stop processing subsequent rules after this rule is matched.'."\n" + ."\n" + .'- `true`: Stop processing subsequent rules.'."\n" + ."\n" + .'- `false`: Continue processing subsequent rules. This is the default value.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], 'required' => false, 'title' => '', @@ -85978,163 +48531,75 @@ 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ - 'description' => 'Session persistence, with possible values:'."\n" - .'- off: Not enabled.'."\n" - .'- ip: Session persistence by IP.'."\n" - .'- cookie: Session persistence by cookie.', + 'description' => 'The method for session affinity, which ensures that requests from the same client are routed to the same origin server. Valid values:'."\n" + ."\n" + .'- `off`: Disables session affinity.'."\n" + ."\n" + .'- `ip`: Enables session affinity based on the client IP address.'."\n" + ."\n" + .'- `cookie`: Enables session affinity based on a cookie.', 'type' => 'string', + 'enum' => [], 'required' => false, 'example' => 'ip', - 'enum' => [], 'title' => '', ], ], [ 'name' => 'SteeringPolicy', 'in' => 'query', - 'schema' => [ - 'description' => 'Load balancing policy.', - 'type' => 'string', - 'required' => false, - 'example' => 'order'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The traffic steering policy, which determines how traffic is distributed among the address pools.', 'type' => 'string', 'required' => false, 'example' => 'order'."\n", 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'Detailed description of the load balancer, for easier management and identification.', - 'type' => 'string', - 'required' => false, - 'example' => '负载均衡器描述'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'An optional description of the load balancer for easier identification and management.', 'type' => 'string', 'example' => 'Load balancer description', 'required' => false, 'title' => ''], ], [ 'name' => 'Ttl', 'in' => 'query', - 'schema' => [ - 'description' => 'TTL value, the time-to-live for DNS records, with a default of 30 and a range of 10-600.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '300', - 'title' => '', - ], + 'schema' => ['description' => 'The Time to Live (TTL) for the DNS record, in seconds. The default is 30. The value must be between 10 and 600, inclusive.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '300', 'title' => ''], ], [ 'name' => 'Monitor', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'Monitor configuration for health checks.', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'Monitor protocol type, such as HTTP, used for health checks. When set to \'off\', no checks are performed.', - 'type' => 'string', - 'required' => false, - 'example' => 'HTTP', - 'title' => '', - ], - 'Method' => [ - 'description' => 'Monitor request method, such as GET, which is a method in the HTTP protocol.', - 'type' => 'string', - 'required' => false, - 'example' => 'GET', - 'title' => '', - ], - 'Port' => [ - 'description' => 'Origin server port.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '80', - 'title' => '', - ], - 'Path' => [ - 'description' => 'Monitor check path, such as /healthcheck, which is the HTTP request path.', - 'type' => 'string', - 'required' => false, - 'example' => '/health'."\n", - 'title' => '', - ], - 'Interval' => [ - 'description' => 'Monitor interval, such as 60 seconds, which is the frequency of checks.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - 'title' => '', - ], - 'Timeout' => [ - 'description' => 'Application health check timeout, in seconds, with a range of 1-10.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - 'title' => '', - ], - 'ExpectedCodes' => [ - 'description' => 'Expected status codes, such as 200,202, which indicate successful HTTP responses.', - 'type' => 'string', - 'required' => false, - 'example' => '200,202', - 'title' => '', - ], - 'FollowRedirects' => [ - 'description' => 'Whether to follow redirects.'."\n" + 'description' => 'The health check monitor configuration.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The protocol to use for the health check, such as `HTTP`. If you set this to `off`, no health check is performed.', 'type' => 'string', 'required' => false, 'example' => 'HTTP', 'title' => ''], + 'Method' => ['description' => 'The HTTP method to use for the health check. For example, `GET`.', 'type' => 'string', 'required' => false, 'example' => 'GET', 'title' => ''], + 'Port' => ['description' => 'The port on the origin server to use for the health check.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80', 'title' => ''], + 'Path' => ['description' => 'The path on the origin server to request for the health check. For example, `/healthcheck`.', 'type' => 'string', 'required' => false, 'example' => '/health'."\n", 'title' => ''], + 'Interval' => ['description' => 'The interval in seconds between each health check. For example, `60`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + 'Timeout' => ['description' => 'The timeout for the health check, in seconds. The value must be between 1 and 10, inclusive.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], + 'ExpectedCodes' => ['description' => 'The expected HTTP status codes that indicate a healthy response. For example, `200,202`.', 'type' => 'string', 'required' => false, 'example' => '200,202', 'title' => ''], + 'FollowRedirects' => ['description' => 'Specifies whether the health check monitor follows HTTP redirections.'."\n" + ."\n" + .'- `true`: The monitor follows HTTP redirections.'."\n" + ."\n" + .'- `false`: The monitor does not follow HTTP redirections.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'ConsecutiveUp' => ['description' => 'The number of consecutive successful health checks required to declare an origin server healthy. For example, `3`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'ConsecutiveDown' => ['description' => 'The number of consecutive failed health checks required to declare an origin server unhealthy. For example, `5`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], + 'Header' => ['description' => 'The HTTP request headers to send with each health check.', 'type' => 'any', 'required' => false, 'example' => ' {'."\n" + .' "host": ['."\n" + .' "example1.com",'."\n" + .' "example2.com"'."\n" + .' ]'."\n" + .' }', 'title' => ''], + 'MonitoringRegion' => [ + 'description' => 'The regions from which the health checks are performed. The default value is `Global`.'."\n" ."\n" - .'- true: Yes.'."\n" - .'- false: No.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], - 'ConsecutiveUp' => [ - 'description' => 'Number of consecutive successful probes required to consider the target healthy, such as 3.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - 'title' => '', - ], - 'ConsecutiveDown' => [ - 'description' => 'Number of consecutive failed probes required to consider the target unhealthy, such as 5.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - 'title' => '', - ], - 'Header' => [ - 'description' => 'Monitor request header configuration.', - 'type' => 'any', + .'- `Global`: From probe locations worldwide.'."\n" + ."\n" + .'- `ChineseMainland`: From probe locations within the Chinese mainland.'."\n" + ."\n" + .'- `OutsideChineseMainland`: From probe locations outside the Chinese mainland.', + 'enumValueTitles' => ['OutsideChineseMainland' => 'Outside Chinese mainland', 'ChineseMainland' => 'Chinese mainland', 'Global' => 'Global'], + 'type' => 'string', 'required' => false, - 'example' => ' {'."\n" - .' "host": ['."\n" - .' "example1.com",'."\n" - .' "example2.com"'."\n" - .' ]'."\n" - .' }', - 'title' => '', - ], - 'MonitoringRegion' => [ - 'enumValueTitles' => [ - 'OutsideChineseMainland' => 'OutsideChineseMainland', - 'ChineseMainland' => 'ChineseMainland', - 'Global' => 'Global', - ], - 'description' => 'The region where the detection point is located. The default value is Global.'."\n" - ."\n" - .'- Global: Global.'."\n" - .'- ChineseMainland: the Chinese mainland.'."\n" - .'- OutsideChineseMainland: Global (excluding the Chinese mainland).', - 'type' => 'string', - 'required' => false, - 'example' => 'Global', + 'example' => 'Global', 'title' => '', ], ], @@ -86146,59 +48611,35 @@ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'Load balancer ID, which can be obtained by calling the [ListLoadBalancers](~~2868897~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '95913670174****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the load balancer. You can obtain this ID by calling the [ListLoadBalancers](~~2868897~~) API operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '95913670174****', 'title' => ''], ], [ 'name' => 'RegionPools', 'in' => 'query', - 'schema' => [ - 'description' => 'Address pool corresponding to the primary region.', - 'type' => 'any', - 'required' => false, - 'example' => '{'."\n" - .' "ENAM": ['."\n" - .' 12345678****'."\n" - .' ],'."\n" - .' "WNAM": ['."\n" - .' 23456789****,'."\n" - .' 23456789****'."\n" - .' ]'."\n" - .'}', - 'title' => '', - ], + 'schema' => ['description' => 'A map of primary regions to their corresponding address pools.', 'type' => 'any', 'required' => false, 'example' => '{'."\n" + .' "ENAM": ['."\n" + .' 12345678****'."\n" + .' ],'."\n" + .' "WNAM": ['."\n" + .' 23456789****,'."\n" + .' 23456789****'."\n" + .' ]'."\n" + .'}', 'title' => ''], ], [ 'name' => 'SubRegionPools', 'in' => 'query', - 'schema' => [ - 'description' => 'Address pool corresponding to the secondary region. When multiple secondary regions share the same address pool, the regions can be concatenated with commas as the key.', - 'type' => 'any', - 'required' => false, - 'example' => '{"AL,MO": [92298024898****],"CN-SH,CN-SX,CN-SC":[92304347804****,92843536908****]}', - 'title' => '', - ], + 'schema' => ['description' => 'A map of secondary regions to their corresponding address pools. To assign the same address pools to multiple secondary regions, combine their codes into a single, comma-separated key.', 'type' => 'any', 'required' => false, 'example' => '{"AL,MO": [92298024898****],"CN-SH,CN-SX,CN-SC":[92304347804****,92843536908****]}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Response structure after successfully updating the load balancer.', + 'description' => 'The structure of the response returned for a successful load balancer update.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n", - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n"], ], 'example' => '', ], @@ -86206,162 +48647,50 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'LoadBalancerQuotaCheckFailed', - 'errorMessage' => 'Load balancer enable quota check failed.', - 'description' => 'Your current plan cannot use the load balancer related functions. If you need to use it, upgrade the plan.', - ], - [ - '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' => '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.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'LoadBalancerPolicyCheckFailed', - 'errorMessage' => 'Your current plan does not support the load balancer scheduling policy. Upgrade the plan and try again.', - 'description' => 'Your current plan does not support the load balancer scheduling policy. Upgrade the plan and try again.', - ], - [ - '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' => 'Your current plan does not allow you to configure the load balancer\'s health detection. Upgrade the plan and try again.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'MonitorExpectedBodyInvalid', - 'errorMessage' => 'Invalid response body. Specify a response body that does not exceed 102,400 characters in length in your custom rule.', - 'description' => 'Invalid response body. Specify a response body that does not exceed 102,400 characters in length in your custom rule.', - ], - [ - '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' => '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.', - ], - [ - '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' => 'The incoming monitor is carrying an illegal request header. Make sure that the number of request headers does not exceed 10, that each request header has a value length between 1 and 10, and that you must not use the User-Agent request header (which is reserved for internal specific scenarios). In addition, the total length of all request headers and their values must not exceed 6000 characters. Please check and correct the request header configuration and try again.', - ], - [ - 'errorCode' => 'MonitorMethodNotSupport', - 'errorMessage' => 'Invalid HTTP method for the probe request. Valid values are GET and HEAD.', - 'description' => 'Invalid HTTP method for the probe request. Valid values are GET and 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' => '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.', - ], - [ - 'errorCode' => 'MonitorPortNotSupport', - 'errorMessage' => 'Invalid probe port. Specify a valid port from 1 to 65535 for the probe request. Then, try again.', - 'description' => 'The incoming monitor listening port is not supported. The port value range is [1-65535]. Please ensure that the port is within the value range and try again.', - ], - [ - 'errorCode' => 'MonitorRetriesInvalid', - 'errorMessage' => 'Invalid number of probe retries. Specify an integer from 0 to 5. Then, try again.', - 'description' => 'Invalid number of probe retries. Specify an integer from 0 to 5. Then try again.', - ], - [ - 'errorCode' => 'MonitorTimeoutInvalid', - 'errorMessage' => 'Invalid timeout for the probe. Valid values are 1 to 10.', - 'description' => 'Invalid timeout for the probe. Valid values are 1 to 10.', - ], - [ - 'errorCode' => 'MonitorTypeNotSupport', - 'errorMessage' => 'Invalid protocol. Valid values are off, HTTP, HTTPS, TCP, UDP, ICMP Ping, and SMTP.', - 'description' => 'Invalid protocol. Valid values are off, HTTP, HTTPS, TCP, UDP, ICMP Ping, and 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' => 'The specified origin pool does not exist or does not belong to your account or website. Check and try again.', - ], - [ - 'errorCode' => 'LoadBalancerNameConflict', - 'errorMessage' => 'The load balancer name or the hostname for the origin pool already exists. Try again with a unique name.', - 'description' => 'The load balancer name or the hostname for the origin pool already exists. Try again with a unique name.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - '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' => '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.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'LoadBalancerQuotaCheckFailed', 'errorMessage' => 'Load balancer enable quota check failed.', 'description' => 'Your current plan cannot use the load balancer related functions. If you need to use it, upgrade the plan.'], + ['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' => '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.'], + ['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' => '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.'], + ['errorCode' => 'LoadBalancerPolicyCheckFailed', 'errorMessage' => 'Your current plan does not support the load balancer scheduling policy. Upgrade the plan and try again.', 'description' => 'Your current plan does not support the load balancer scheduling policy. Upgrade the plan and try again.'], + ['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' => 'Your current plan does not allow you to configure the load balancer\'s health detection. Upgrade the plan and try again.'], + ['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' => '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.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'MonitorExpectedBodyInvalid', 'errorMessage' => 'Invalid response body. Specify a response body that does not exceed 102,400 characters in length in your custom rule.', 'description' => 'Invalid response body. Specify a response body that does not exceed 102,400 characters in length in your custom rule.'], + ['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' => '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.'], + ['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' => 'The incoming monitor is carrying an illegal request header. Make sure that the number of request headers does not exceed 10, that each request header has a value length between 1 and 10, and that you must not use the User-Agent request header (which is reserved for internal specific scenarios). In addition, the total length of all request headers and their values must not exceed 6000 characters. Please check and correct the request header configuration and try again.'], + ['errorCode' => 'MonitorMethodNotSupport', 'errorMessage' => 'Invalid HTTP method for the probe request. Valid values are GET and HEAD.', 'description' => 'Invalid HTTP method for the probe request. Valid values are GET and 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' => '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.'], + ['errorCode' => 'MonitorPortNotSupport', 'errorMessage' => 'Invalid probe port. Specify a valid port from 1 to 65535 for the probe request. Then, try again.', 'description' => 'The incoming monitor listening port is not supported. The port value range is [1-65535]. Please ensure that the port is within the value range and try again.'], + ['errorCode' => 'MonitorRetriesInvalid', 'errorMessage' => 'Invalid number of probe retries. Specify an integer from 0 to 5. Then, try again.', 'description' => 'Invalid number of probe retries. Specify an integer from 0 to 5. Then try again.'], + ['errorCode' => 'MonitorTimeoutInvalid', 'errorMessage' => 'Invalid timeout for the probe. Valid values are 1 to 10.', 'description' => 'Invalid timeout for the probe. Valid values are 1 to 10.'], + ['errorCode' => 'MonitorTypeNotSupport', 'errorMessage' => 'Invalid protocol. Valid values are off, HTTP, HTTPS, TCP, UDP, ICMP Ping, and SMTP.', 'description' => 'Invalid protocol. Valid values are off, HTTP, HTTPS, TCP, UDP, ICMP Ping, and 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' => 'The specified origin pool does not exist or does not belong to your account or website. Check and try again.'], + ['errorCode' => 'LoadBalancerNameConflict', 'errorMessage' => 'The load balancer name or the hostname for the origin pool already exists. Try again with a unique name.', 'description' => 'The load balancer name or the hostname for the origin pool already exists. Try again with a unique name.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['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' => '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.'], + ['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' => '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.'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], ], 403 => [ - [ - 'errorCode' => 'QuotaExceeded', - 'errorMessage' => 'The quota is exceeded.', - 'description' => 'The quota is exceeded.', - ], + ['errorCode' => 'QuotaExceeded', 'errorMessage' => 'The quota is exceeded.', 'description' => 'The quota is exceeded.'], ], [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEBE525-F576-1196-8DAF-2D70CA3F4D2F\\\\n\\"\\n}","type":"json"}]', 'title' => 'Modify Existing Load Balancer Information', - 'description' => 'Through this interface, you can modify multiple configurations of the load balancer, including but not limited to the name of the load balancer, whether to enable acceleration, session persistence strategy, and various advanced settings related to traffic routing.>Changes to certain parameters may affect the stability of existing services, please operate with caution.>', + 'description' => 'This operation modifies multiple configurations for a load balancer, including its name, acceleration status, session persistence policy, and advanced traffic routing settings.>Changes to certain parameters might affect the stability of existing services. Proceed with caution.>', 'changeSet' => [ - [ - 'createdAt' => '2025-06-16T02:25:11.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2025-02-13T01:34:54.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-06-16T02:25:11.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-13T01:34:54.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateLoadBalancer', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLoadBalancer'], ], ], 'ramActions' => [ @@ -86372,25 +48701,17 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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"}]', + 'translator' => 'manual', ], 'UpdateManagedTransform' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Modify the site hosting transformation configuration.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -86403,68 +48724,48 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257446', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the site. You can call the [ListSites](~~2850189~~) operation to obtain this ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'AddClientGeolocationHeader', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to include the header that indicates the geographical location of a client in an origin request. Valid values:'."\n" + 'description' => 'Specifies whether to add a header that contains visitor geolocation information. Valid values:'."\n" ."\n" - .'* on'."\n" - .'* off'."\n", + .'- `on`: Add the header.'."\n" + ."\n" + .'- `off`: Do not add the header.', + 'enumValueTitles' => ['off' => 'off', 'on' => 'on'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], - 'example' => 'on', 'enum' => [], + 'example' => 'on', 'title' => '', ], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The version number of the website. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The version of the site. For sites with version management enabled, this parameter specifies the version to which the configuration applies. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'AddRealClientIpHeader', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to include the "ali-real-client-ip" header that indicates the client\'s real IP address in an origin request. Valid values:'."\n" + 'description' => 'Specifies whether to add the `ali-real-client-ip` header, which contains the real client IP. Valid values:'."\n" ."\n" - .'* on'."\n" - .'* off'."\n", + .'- `on`: Add the header.'."\n" + ."\n" + .'- `off`: Do not add the header.', + 'enumValueTitles' => ['off' => 'off', 'on' => 'on'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], 'example' => 'on', 'title' => '', ], @@ -86472,28 +48773,17 @@ [ 'name' => 'RealClientIpHeaderName', 'in' => 'query', - 'schema' => [ - 'description' => 'The header name for the real client IP.', - 'type' => 'string', - 'required' => false, - 'example' => 'test_header', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the header that contains the real client IP. The name must start with a letter and can contain letters, digits (0-9), and hyphens (-).', 'type' => 'string', 'required' => false, 'example' => 'test-header', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'], ], 'example' => '', ], @@ -86501,181 +48791,66 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => '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.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\"\\n}","type":"json"}]', 'title' => 'Modify Site Managed Transformation Configuration', - 'summary' => 'Modify Site Managed Transformation Configuration', 'changeSet' => [ - [ - 'createdAt' => '2025-05-09T05:58:31.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-05-09T05:58:31.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateManagedTransform', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateManagedTransform'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateManagedTransform', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\"\\n}","type":"json"}]', ], 'UpdateNetworkOptimization' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -86688,161 +48863,97 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257971', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) API.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. Call the [ListSites](~~2850189~~) operation to obtain this ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '352816096987136', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '352816096987136', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. This parameter is optional for global configurations.', 'type' => 'string', 'required' => false, 'example' => 'rule_example', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Possible values:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Controls whether the rule is enabled. This parameter is optional for global configurations. Valid values:'."\n" + ."\n" + .'- on: The rule is enabled.'."\n" + ."\n" + .'- off: The rule is disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq \\"video.example.com\\")', - 'title' => '', - ], + 'schema' => ['description' => 'The conditional expression used to match requests. This parameter is optional for global configurations.'."\n" + ."\n" + .'- To match all incoming requests, set the value to true.'."\n" + ."\n" + .'- To match specific requests, set the value to a custom expression, for example, (http.host eq "video.example.com").', 'type' => 'string', 'required' => false, 'example' => '(http.host eq \\"video.example.com\\")', 'title' => ''], ], [ 'name' => 'SmartRouting', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable the smart routing service, default is disabled. Possible values:'."\n" - .'- on: Enable'."\n" - .'- off: Disable', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Controls whether smart routing is enabled. This feature is disabled by default. Valid values:'."\n" + ."\n" + .'- on: Smart routing is enabled.'."\n" + ."\n" + .'- off: Smart routing is disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Http2Origin', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable HTTP2 origin, default is disabled. Possible values:'."\n" - .'- on: Enable'."\n" - .'- off: Disable', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Controls whether HTTP/2 to origin is enabled. This feature is disabled by default. Valid values:'."\n" + ."\n" + .'- on: HTTP/2 to origin is enabled.'."\n" + ."\n" + .'- off: HTTP/2 to origin is disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Websocket', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable Websocket, default is enabled. Possible values:'."\n" - .'- on: Enable'."\n" - .'- off: Disable', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Controls whether WebSocket is enabled. This feature is enabled by default. Valid values:'."\n" + ."\n" + .'- on: WebSocket is enabled.'."\n" + ."\n" + .'- off: WebSocket is disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Grpc', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to enable GRPC, default is disabled. Possible values:'."\n" - .'- on: Enable'."\n" - .'- off: Disable', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Controls whether gRPC is enabled. This feature is disabled by default. Valid values:'."\n" + ."\n" + .'- on: gRPC is enabled.'."\n" + ."\n" + .'- off: gRPC is disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'UploadMaxFilesize', 'in' => 'query', - 'schema' => [ - 'description' => 'Maximum upload file size, in MB, with a range of 100 to 500.', - 'type' => 'string', - 'required' => false, - 'example' => '100', - 'title' => '', - ], + 'schema' => ['description' => 'The maximum upload file size, in MB. The value must be an integer from 100 to 500.', 'type' => 'string', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'The rule execution order. A smaller numeric value indicates a higher priority.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The rule execution order. Smaller values have higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'], ], 'example' => '', ], @@ -86850,151 +48961,43 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], 'title' => 'Modify Site Network Optimization Configuration', - 'summary' => 'Modify network optimization configuration', + 'summary' => 'Updates a network optimization configuration.', 'changeSet' => [ - [ - 'createdAt' => '2025-03-27T02:58:48.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-03-27T02:58:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateNetworkOptimization', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateNetworkOptimization'], ], ], 'ramActions' => [ @@ -87005,12 +49008,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -87018,13 +49016,9 @@ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\"\\n}","type":"json"}]', ], 'UpdateOriginPool' => [ - 'summary' => 'Modify the Monitor', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Modifies a single origin address pool specified by the origin address pool ID.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -87037,157 +49031,74 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238439', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the origin pool, which can be obtained by calling the [ListOriginPools](~~2863947~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1038520525196928', - 'title' => '', - ], + 'schema' => ['description' => 'The origin address pool ID. You can call the [ListOriginPools](~~ListOriginPools~~) operation to obtain the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1038520525196928', 'title' => ''], ], [ 'name' => 'Enabled', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether the origin pool is enabled:'."\n" - ."\n" - .'- true: Enabled;'."\n" - .'- false: Disabled.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether the origin address pool is enabled. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Not enabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'Origins', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'Information about the origins added to the origin pool. Multiple origins are passed as an array.', + 'description' => 'The origin server information added to the origin address pool. Use an array to pass multiple origin servers.', 'type' => 'array', 'items' => [ - 'description' => 'Information about the origins added to the origin pool.', + 'description' => 'The origin server information added to the origin address pool.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the origin, which must be unique under one origin pool.', - 'type' => 'string', - 'required' => false, - 'example' => 'origin1', - 'title' => '', - ], - 'Address' => [ - 'description' => 'The address of the origin, e.g., www.example.com.', - 'type' => 'string', - 'required' => false, - 'example' => 'www.example.com', - 'title' => '', - ], - 'Enabled' => [ - 'description' => 'Whether the origin is enabled:'."\n" - ."\n" - .'- true: Enabled;'."\n" - .'- false: Disabled.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], - 'Header' => [ - 'description' => 'The request header to be included when fetching from the origin, supporting only Host.', - 'type' => 'any', - 'required' => false, - 'example' => '{'."\n" - .' "Host": ['."\n" - .' "example.com"'."\n" - .' ]'."\n" - .' }', - 'title' => '', - ], - 'Weight' => [ - 'description' => 'The weight, an integer between 0 and 100.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The type of the origin:'."\n" - ."\n" - .'- ip_domain: IP or domain type origin;'."\n" - .'- OSS: OSS address origin;'."\n" - .'- S3: AWS S3 origin.', - 'type' => 'string', - 'required' => false, - 'example' => 'OSS', - 'title' => '', - ], + 'Name' => ['description' => 'The origin server name. The name must be unique within an origin address pool.', 'type' => 'string', 'required' => false, 'example' => 'origin1', 'title' => ''], + 'Address' => ['description' => 'The addresses of the origin server, such as www.example.com.', 'type' => 'string', 'required' => false, 'example' => 'www.example.com', 'title' => ''], + 'Enabled' => ['description' => 'Specifies whether the origin server is enabled. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Not enabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'Header' => ['description' => 'The request header included in back-to-origin requests. Only Host is supported.', 'type' => 'any', 'required' => false, 'example' => '{'."\n" + .' "Host": ['."\n" + .' "example.com"'."\n" + .' ]'."\n" + .' }', 'title' => ''], + 'Weight' => ['description' => 'The weight. The value is an integer from 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], + 'Type' => ['description' => 'The origin server type. Valid values:'."\n" + ."\n" + .'- ip_domain: an IP address or domain name-based origin server.'."\n" + .'- OSS: an OSS address-based origin server.'."\n" + .'- S3: an AWS S3 origin server.', 'type' => 'string', 'required' => false, 'example' => 'OSS', 'title' => ''], 'AuthConf' => [ - 'description' => 'Authentication information. When the origin is OSS or S3 and requires authentication, you need to pass the related configuration information for authentication.', + 'description' => 'The authentication information. This parameter is required when the origin server is OSS, S3, or another origin server that requires authentication.', 'type' => 'object', 'properties' => [ - 'AuthType' => [ - 'description' => 'The type of authentication.'."\n" - ."\n" - .'- public: Public read/write, used when the origin is OSS or S3 and is set to public read/write;'."\n" - .'- private_same_account: Private same account, used when the origin is OSS and the authentication type is private within the same account;'."\n" - .'- private_cross_account: Private cross-account, used when the origin is OSS and the authentication type is private across accounts;'."\n" - .'- private: Used when the origin is S3 and the authentication type is private.', - 'type' => 'string', - 'required' => false, - 'example' => 'public', - 'title' => '', - ], - 'AccessKey' => [ - 'description' => 'The AccessKey required for private authentication.', - 'type' => 'string', - 'required' => false, - 'example' => 'yourAccessKeyID', - 'title' => '', - ], - 'SecretKey' => [ - 'description' => 'The SecretKey required for private authentication.', - 'type' => 'string', - 'required' => false, - 'example' => 'yourAccessKeySecret', - 'title' => '', - ], - 'Version' => [ - 'description' => 'The signature version required when the origin is AWS S3.', - 'type' => 'string', - 'required' => false, - 'example' => 'v2', - 'title' => '', - ], - 'Region' => [ - 'description' => 'The region of the origin required when the origin is AWS S3.', - 'type' => 'string', - 'required' => false, - 'example' => 'us-east-1'."\n", - 'title' => '', - ], + 'AuthType' => ['description' => 'The authentication type. Valid values:'."\n" + ."\n" + .'- public: public read/write. Use this value when the origin server is OSS or S3 with public read/write access.'."\n" + .'- private_same_account: private same-account. Use this value when the origin server is OSS with same-account private authentication.'."\n" + .'- private_cross_account: private cross-account. Use this value when the origin server is OSS with cross-account private authentication.'."\n" + .'- private: Use this value when the origin server is S3 with private authentication.', 'type' => 'string', 'required' => false, 'example' => 'public', 'title' => ''], + 'AccessKey' => ['description' => 'The AccessKey required for private authentication.', 'type' => 'string', 'required' => false, 'example' => 'yourAccessKeyID', 'title' => ''], + 'SecretKey' => ['description' => 'The SecretKey required for private authentication.', 'type' => 'string', 'required' => false, 'example' => 'yourAccessKeySecret', 'title' => ''], + 'Version' => ['description' => 'The signature version required when the origin server is AWS S3.', 'type' => 'string', 'required' => false, 'example' => 'v2', 'title' => ''], + 'Region' => ['description' => 'The region of the origin server required when the origin server is AWS S3.', 'type' => 'string', 'required' => false, 'example' => 'us-east-1'."\n", 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], - 'IpVersionPolicy' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'IpVersionPolicy' => ['description' => 'The IP protocol version used for back-to-origin requests. Valid values:'."\n" + .'- round_robin: default policy. Randomly polls IPv4 or IPv6 origin servers.'."\n" + .'- ipv4_first: preferentially uses IPv4 origin servers.'."\n" + .'- ipv6_first: preferentially uses IPv6 origin servers.'."\n" + .'- follow: preferentially follows the IP version used by the client.', 'type' => 'string', 'required' => false, 'example' => 'round_robin', 'title' => ''], ], 'required' => false, 'title' => '', @@ -87201,36 +49112,18 @@ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '216558609793952', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '216558609793952', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - ], - 'Id' => [ - 'description' => 'Source address pool ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1038520525196928', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74'], + 'Id' => ['description' => 'The origin address pool ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1038520525196928', 'title' => ''], ], 'example' => '', ], @@ -87238,120 +49131,58 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'SourceNumberExceedLimit', - 'errorMessage' => 'The number of sources in the origin pool exceeds the quota limit.', - 'description' => 'The number of sources that can be created in the origin pool has reached the upper limit of the package. Please check your package quota and upgrade the package to obtain more quota.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'OriginPoolNotExist', - 'errorMessage' => 'The specified origin pool does not exist or does not belong to your account or website. Check and try again.', - 'description' => 'The specified origin pool does not exist or does not belong to your account or website. Check and try again.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => 'The specified origin pool name already exists or its hostname conflicts with a load balancer name. Try again with a unique name.', - ], - [ - 'errorCode' => 'SourceAddressInvalid', - 'errorMessage' => 'Invalid origin address. Check whether the IP address or domain name is in the valid format.', - 'description' => 'Invalid origin address. Check whether the IP address or domain name is in the valid format.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'InvalidParameter.AddressConflict', - 'errorMessage' => 'Duplicate origin addresses. Make sure that each origin address for the same pool is unique.', - 'description' => 'Duplicate origin addresses. Make sure that each origin address for the same pool is unique.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'SourceInBlackList', - 'errorMessage' => 'The source is in the black list.', - 'description' => 'The source is in the black list.', - ], - [ - 'errorCode' => 'InvalidParameter.SourceIpInBlacklist', - 'errorMessage' => 'The provided origin is an invalid private IP address. Please verify and resubmit.', - 'description' => 'The provided origin is an invalid private IP address. Please verify and resubmit.', - ], - [ - 'errorCode' => 'InvalidParameter.PrivateIpAsSourceUnsupported', - 'errorMessage' => 'The provided origin is an invalid private IP address. Please verify and resubmit.', - 'description' => 'The provided origin is an invalid private IP address. Please verify and resubmit.', - ], - [ - 'errorCode' => 'OriginPool.TypeNotSupport', - 'errorMessage' => 'The origin address pool type is not supported.', - 'description' => 'The origin address pool type is not supported.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'SourceNumberExceedLimit', 'errorMessage' => 'The number of sources in the origin pool exceeds the quota limit.', 'description' => 'The number of sources that can be created in the origin pool has reached the upper limit of the package. Please check your package quota and upgrade the package to obtain more quota.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'OriginPoolNotExist', 'errorMessage' => 'The specified origin pool does not exist or does not belong to your account or website. Check and try again.', 'description' => 'The specified origin pool does not exist or does not belong to your account or website. Check and try again.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => 'The specified origin pool name already exists or its hostname conflicts with a load balancer name. Try again with a unique name.'], + ['errorCode' => 'SourceAddressInvalid', 'errorMessage' => 'Invalid origin address. Check whether the IP address or domain name is in the valid format.', 'description' => 'Invalid origin address. Check whether the IP address or domain name is in the valid format.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'InvalidParameter.AddressConflict', 'errorMessage' => 'Duplicate origin addresses. Make sure that each origin address for the same pool is unique.', 'description' => 'Duplicate origin addresses. Make sure that each origin address for the same pool is unique.'], + ['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' => '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.'], + ['errorCode' => 'SourceInBlackList', 'errorMessage' => 'The source is in the black list.', 'description' => 'The source is in the black list.'], + ['errorCode' => 'InvalidParameter.SourceIpInBlacklist', 'errorMessage' => 'The provided origin is an invalid private IP address. Please verify and resubmit.', 'description' => 'The provided origin is an invalid private IP address. Please verify and resubmit.'], + ['errorCode' => 'InvalidParameter.PrivateIpAsSourceUnsupported', 'errorMessage' => 'The provided origin is an invalid private IP address. Please verify and resubmit.', 'description' => 'The provided origin is an invalid private IP address. Please verify and resubmit.'], + ['errorCode' => 'OriginPool.TypeNotSupport', 'errorMessage' => 'The origin address pool type is not supported.', 'description' => 'The origin address pool type is not supported.'], + ['errorCode' => 'OriginPool.CheckQuotaFailed', 'errorMessage' => 'Failed to check source pool quota for site, please try again later.', 'description' => 'Failed to check source pool quota for site, please try again later.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'title' => 'Update a Single Origin Pool', + 'title' => 'Modify a single origin address pool', 'changeSet' => [ - [ - 'createdAt' => '2025-05-20T11:43:19.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-05-20T11:43:19.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateOriginPool', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateOriginPool'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateOriginPool', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\",\\n \\"Id\\": 1038520525196928\\n}","type":"json"}]', ], 'UpdateOriginProtection' => [ - 'summary' => 'Enables or disables IP convergence.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -87364,38 +49195,27 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '250098', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4VDL9A', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4VDL9A'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. Call the [ListSites](~~2850189~~) API to get it.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'OriginConverge', 'in' => 'query', 'schema' => [ - 'description' => 'The IP convergence status.'."\n" + 'description' => 'The origin fetch convergence switch.'."\n" ."\n" - .'* on'."\n" - .'* off'."\n", + .'- on: Enable origin fetch convergence.'."\n" + ."\n" + .'- off: Disable origin fetch convergence.', 'type' => 'string', 'required' => true, + 'enum' => ['on', 'off'], 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], @@ -87407,12 +49227,9 @@ 'type' => 'string', 'required' => false, 'example' => 'off', - 'enum' => [ - 'on', - 'off', - ], - 'title' => '', + 'enum' => ['on', 'off'], 'description' => '', + 'title' => '', ], ], ], @@ -87420,15 +49237,10 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4C6B5E5A-42FC-5DF2-986C-4DAAE3C55086', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4C6B5E5A-42FC-5DF2-986C-4DAAE3C55086'], ], 'example' => '', ], @@ -87436,110 +49248,76 @@ ], '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.', - ], - [ - 'errorCode' => 'OriginProtectionNotExist', - 'errorMessage' => 'The site is not configured with origin protection, so it cannot be modified or deleted.', - 'description' => 'The site is not configured with origin protection, so it cannot be modified or deleted.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.'], + ['errorCode' => 'OriginProtectionNotExist', 'errorMessage' => 'The site is not configured with origin protection, so it cannot be modified or deleted.', 'description' => 'The site is not configured with origin protection, so it cannot be modified or deleted.'], + ['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' => '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.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], 'title' => 'UpdateOriginProtection', + 'summary' => 'Modify the origin protection feature to enable or disable origin fetch convergence.', 'changeSet' => [ - [ - 'createdAt' => '2025-02-21T06:58:57.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-02-21T06:58:57.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '5', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateOriginProtection', + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateOriginProtection'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'esa:UpdateOriginProtection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C6B5E5A-42FC-5DF2-986C-4DAAE3C55086\\"\\n}","type":"json"}]', ], 'UpdateOriginProtectionIpWhiteList' => [ - 'summary' => 'Updates the IP whitelist for origin protection used by a website to the latest version.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Confirm that you want to update the site’s origin IP whitelist to the latest version.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '250107', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4VDL9A', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4VDL9A'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID. Call the [ListSites](~~2850189~~) operation to get this value.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'], ], 'example' => '', ], @@ -87547,36 +49325,22 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'OriginProtectionNotExist', - 'errorMessage' => 'The site is not configured with origin protection, so it cannot be modified or deleted.', - 'description' => 'The site is not configured with origin protection, so it cannot be modified or deleted.', - ], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'OriginProtectionNotExist', 'errorMessage' => 'The site is not configured with origin protection, so it cannot be modified or deleted.', 'description' => 'The site is not configured with origin protection, so it cannot be modified or deleted.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\"\\n}","type":"json"}]', 'title' => 'UpdateOriginProtectionIpWhiteList', 'changeSet' => [ - [ - 'createdAt' => '2025-02-21T06:58:57.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-02-21T06:58:57.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '5', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateOriginProtectionIpWhiteList', - ], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateOriginProtectionIpWhiteList'], ], ], 'ramActions' => [ @@ -87587,25 +49351,17 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'operationType' => 'write', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\"\\n}","type":"json"}]', ], 'UpdateOriginRule' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Updates a site\'s origin fetch rules.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -87618,294 +49374,176 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257994', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '5407498413****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can get this ID by calling the [ListSites](~~ListSites~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5407498413****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '35281609698****', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. This parameter is not required when you add a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Valid values:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Indicates whether the rule is enabled. This parameter is not required when you add a global configuration. Valid values:'."\n" + ."\n" + .'- `on`: Enables the rule.'."\n" + ."\n" + .'- `off`: Disables the rule.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content, used to match user requests with conditional expressions. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq \\"video.example.com\\")', - 'title' => '', - ], + 'schema' => ['description' => 'The rule content, which is a conditional expression that matches user requests. This parameter is not required when you add a global configuration.'."\n" + ."\n" + .'- To match all incoming requests, set the value to `true`.'."\n" + ."\n" + .'- To match specific requests, set the value to a custom expression, such as `(http.host eq "video.example.com")`.', 'type' => 'string', 'required' => false, 'example' => '(http.host eq \\"video.example.com\\")', 'title' => ''], ], [ 'name' => 'OriginHost', 'in' => 'query', - 'schema' => [ - 'description' => 'The HOST carried in the origin request.', - 'type' => 'string', - 'required' => false, - 'example' => 'origin.example.com'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The `Host` header for the origin request.', 'type' => 'string', 'required' => false, 'example' => 'origin.example.com'."\n", 'title' => ''], ], [ 'name' => 'OriginScheme', 'in' => 'query', - 'schema' => [ - 'description' => 'Protocol used for the origin request. Valid values:'."\n" - .'- http: Use HTTP protocol for origin pull.'."\n" - .'- https: Use HTTPS protocol for origin pull.'."\n" - .'- follow: Follow the client\'s protocol for origin pull.', - 'type' => 'string', - 'required' => false, - 'example' => 'http', - 'title' => '', - ], + 'schema' => ['description' => 'The protocol for origin requests. Valid values:'."\n" + ."\n" + .'- `http`: The origin request uses HTTP.'."\n" + ."\n" + .'- `https`: The origin request uses HTTPS.'."\n" + ."\n" + .'- `follow`: The origin request uses the same protocol as the client request.', 'type' => 'string', 'required' => false, 'example' => 'http', 'title' => ''], ], [ 'name' => 'OriginSni', 'in' => 'query', - 'schema' => [ - 'description' => 'SNI carried in the origin request.', - 'type' => 'string', - 'required' => false, - 'example' => 'origin.example.com'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The Server Name Indication (SNI) for the origin request.', 'type' => 'string', 'required' => false, 'example' => 'origin.example.com'."\n", 'title' => ''], ], [ 'name' => 'DnsRecord', 'in' => 'query', - 'schema' => [ - 'description' => 'Rewrite the DNS resolution record of the origin request.', - 'type' => 'string', - 'required' => false, - 'example' => 'test.example.com'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'Overrides the DNS record for the origin request.', 'type' => 'string', 'required' => false, 'example' => 'test.example.com'."\n", 'title' => ''], ], [ 'name' => 'OriginHttpPort', 'in' => 'query', - 'schema' => [ - 'description' => 'Port of the origin server when using HTTP protocol for origin pull.', - 'type' => 'string', - 'required' => false, - 'example' => '8080', - 'title' => '', - ], + 'schema' => ['description' => 'The origin server port for HTTP requests.', 'type' => 'string', 'required' => false, 'example' => '8080', 'title' => ''], ], [ 'name' => 'OriginHttpsPort', 'in' => 'query', - 'schema' => [ - 'description' => 'Port of the origin server when using HTTPS protocol for origin pull.', - 'type' => 'string', - 'required' => false, - 'example' => '4433', - 'title' => '', - ], + 'schema' => ['description' => 'The origin server port for HTTPS requests.', 'type' => 'string', 'required' => false, 'example' => '4433', 'title' => ''], ], [ 'name' => 'Range', 'in' => 'query', - 'schema' => [ - 'description' => 'Use range chunking for origin pull file download. Valid values:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.'."\n" - .'- force: Force.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Indicates whether to use range requests when fetching files from the origin server. Valid values:'."\n" + ."\n" + .'- `on`: Enables range requests.'."\n" + ."\n" + .'- `off`: Disables range requests.'."\n" + ."\n" + .'- `force`: Enforces range requests.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'OriginMtls', 'in' => 'query', - 'schema' => [ - 'description' => 'mTLS switch. Valid values:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Indicates whether to enable mutual TLS (mTLS) for origin requests. Valid values:'."\n" + ."\n" + .'- `on`: Enables mTLS.'."\n" + ."\n" + .'- `off`: Disables mTLS.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'OriginVerify', 'in' => 'query', - 'schema' => [ - 'description' => 'Origin certificate verification switch. Valid values:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Indicates whether to enable origin certificate verification. Valid values:'."\n" + ."\n" + .'- `on`: Enables verification.'."\n" + ."\n" + .'- `off`: Disables verification.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'RangeChunkSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Range shard size. Valid values:'."\n" - .'- 512 KB'."\n" - .'- 1 MB'."\n" - .'- 2 MB'."\n" - .'- 4 MB', - 'type' => 'string', - 'required' => false, - 'example' => '1MB', - 'title' => '', - ], + 'schema' => ['description' => 'The size of each chunk for range requests. Valid values:'."\n" + ."\n" + .'- 512KB'."\n" + ."\n" + .'- 1MB'."\n" + ."\n" + .'- 2MB'."\n" + ."\n" + .'- 4MB', 'type' => 'string', 'required' => false, 'example' => '1MB', 'title' => ''], ], [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule execution order. Rules with smaller numeric values are executed first.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The execution priority of the rule. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'OriginReadTimeout', 'in' => 'query', - 'schema' => [ - 'description' => 'Origin read timeout (seconds).', - 'type' => 'string', - 'required' => false, - 'example' => '10', - 'title' => '', - ], + 'schema' => ['description' => 'The read timeout period for the origin server, in seconds.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'Follow302Enable', 'in' => 'query', - 'schema' => [ - 'description' => '302 redirection toggle. Valid values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Indicates whether to follow 302 redirects for origin requests. Valid values:'."\n" + ."\n" + .'- `on`: Follows 302 redirects.'."\n" + ."\n" + .'- `off`: Does not follow 302 redirects.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Follow302MaxTries', 'in' => 'query', - 'schema' => [ - 'description' => 'Maximum number of 302 redirect attempts. Valid values: [1–5].', - 'type' => 'string', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The maximum number of 302 redirects to follow. The value must be an integer from 1 to 5.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'Follow302RetainArgs', 'in' => 'query', - 'schema' => [ - 'description' => 'Toggle to retain original request parameters. Valid values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Indicates whether to retain the original request parameters when following a 302 redirect. Valid values:'."\n" + ."\n" + .'- `on`: Retains the parameters.'."\n" + ."\n" + .'- `off`: Does not retain the parameters.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Follow302RetainHeader', 'in' => 'query', - 'schema' => [ - 'description' => 'Toggle to retain original request headers. Valid values:'."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Indicates whether to retain the original request headers when following a 302 redirect. Valid values:'."\n" + ."\n" + .'- `on`: Retains the headers.'."\n" + ."\n" + .'- `off`: Does not retain the headers.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Follow302TargetHost', 'in' => 'query', - 'schema' => [ - 'description' => 'The origin host after a 302 redirect is modified.', - 'type' => 'string', - 'required' => false, - 'example' => 'test.com', - 'title' => '', - ], + 'schema' => ['description' => 'The `Host` header for the redirected origin request.', 'type' => 'string', 'required' => false, 'example' => 'test.com', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9'], ], 'example' => '', ], @@ -87913,186 +49551,68 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], 'title' => 'Modify Origin Rule Configuration for Site', - 'summary' => 'Modify Origin Rule Configuration for Site', 'changeSet' => [ - [ - 'createdAt' => '2025-04-17T08:47:33.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2025-04-01T01:57:04.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2025-03-27T02:58:48.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2025-03-20T05:57:46.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2025-02-27T09:16:40.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-04-17T08:47:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-01T01:57:04.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-27T02:58:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-20T05:57:46.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-27T09:16:40.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateOriginRule', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateOriginRule'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateOriginRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', ], 'UpdatePage' => [ - 'summary' => 'Modifies the configurations of a custom error page, such as the name, description, content type, and content of the page.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Updates a custom response page that the user has created. You can use this operation to modify the page name, description, content type, and content.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -88105,84 +49625,76 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239594', - 'abilityTreeNodes' => [ - 'FEATUREdcdnL8HX1L', - ], + 'abilityTreeNodes' => ['FEATUREdcdnL8HX1L'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => 'The ID of the custom error page, which can be obtained by calling the [ListPages](~~2850223~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '50000001', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the custom response page. You can obtain this value by calling the [ListPages](~~2850223~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '50000001'], ], [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the custom error page.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'example', - ], + 'schema' => ['title' => '', 'description' => 'The name of the custom response page after the update.'."\n" + ."\n" + .'**Naming suggestion**: Use a combination of letters, digits, and underscores (such as `blocked_page_v2`) for easy reference in rules. The character set, maximum length, and uniqueness constraints are subject to the server-side naming conventions for custom pages. If this parameter is not specified, the original name is retained.', 'type' => 'string', 'required' => true, 'example' => 'example'], ], [ 'name' => 'Description', 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => 'The description of the custom error page.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a custom deny page', - ], + 'schema' => ['title' => '', 'description' => 'The description of the page after the update. This is used to identify the purpose of the page in the console list. This is an optional field. If this parameter is not specified, the original description is retained. The maximum field length is subject to the server-side limit.', 'type' => 'string', 'required' => true, 'example' => 'a custom deny page'], ], [ 'name' => 'ContentType', 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => 'The Content-Type field in the HTTP header. Valid values:'."\n" - ."\n" - .'* text/html'."\n" - .'* application/json'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'text/html', - ], + 'schema' => ['title' => '', 'description' => 'The MIME type of the page content, which is returned to the client as the HTTP `Content-Type` response header when a rule is matched.'."\n" + ."\n" + .'**Common values**:'."\n" + .'- `text/html`: HTML page'."\n" + .'- `application/json`: JSON response'."\n" + ."\n" + .'> The complete set of supported values is subject to the server-side specification. The actual format of `Content` must match this field. A mismatch may cause browser rendering issues.', 'type' => 'string', 'required' => true, 'example' => 'text/html'], ], [ 'name' => 'Content', 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The BASE64-encoded page content, which must be consistent with `ContentType`.'."\n" + ."\n" + .'**Encoding method**:'."\n" + .'1. Convert the original page content to a UTF-8 byte string.'."\n" + .'2. Encode the byte string using standard BASE64 encoding.'."\n" + ."\n" + .'**Example**: `hello page` → `PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=`'."\n" + ."\n" + .'> The maximum size limit is subject to the server-side custom page specification. If this parameter is not specified, the original page content is retained.', 'type' => 'string', 'required' => true, 'example' => 'PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4='], + ], + [ + 'name' => 'SiteIds', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ 'title' => '', - 'description' => 'The Base64-encoded content of the error page. The content type is specified by the Content-Type field.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=', + 'description' => 'The list of site IDs associated with this page after the update. This parameter uses full overwrite semantics.'."\n" + ."\n" + .'- You can obtain site IDs by calling the `ListSites` operation.'."\n" + .'- Passing an empty list dissociates all sites from the page.'."\n" + .'- Including a site ID that does not belong to your account returns an `InvalidParameter` error.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The associated site ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], + 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], ], 'example' => '', ], @@ -88190,98 +49702,149 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], 403 => [ - [ - 'errorCode' => '%s.NotSupport', - 'errorMessage' => 'The specified resource type %s is not supported.', - 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.', - ], - [ - 'errorCode' => '%s.OverQuota', - 'errorMessage' => 'The quantity of %s exceeds the quota.', - 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.', - ], - [ - 'errorCode' => '%s.WrongValueMatched', - 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', - 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.', - ], - [ - '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' => '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.', - ], + ['errorCode' => '%s.NotSupport', 'errorMessage' => 'The specified resource type %s is not supported.', 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.'], + ['errorCode' => '%s.OverQuota', 'errorMessage' => 'The quantity of %s exceeds the quota.', 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.'], + ['errorCode' => '%s.WrongValueMatched', 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.'], + ['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' => '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.'], + ['errorCode' => 'Page.SiteAlreadyBound', 'errorMessage' => 'The specified site has already been associated with another custom error page of the same type. Dissociate the site from the existing page and try again.', 'description' => 'The specified site is already bound to another custom response page of the same type. Please first unbind the site from the existing page and then try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\"\\n}","type":"json"}]', - 'title' => 'UpdatePage', + 'title' => 'Update a custom response page', 'changeSet' => [ + ['createdAt' => '2024-12-26T15:07:29.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-25T07:02:48.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T06:13:39.000Z', 'description' => 'Error codes changed'], + ], + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'UpdatePerformanceDataCollection' => [ + 'summary' => 'Modifies the web data quality collection configuration.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'createdAt' => '2024-12-26T15:07:29.000Z', - 'description' => 'Request parameters changed', + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '264793', + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], + ], + 'parameters' => [ [ - 'createdAt' => '2024-09-25T07:02:48.000Z', - 'description' => 'Error codes changed', + 'name' => 'SiteId', + 'in' => 'query', + 'schema' => ['description' => 'The site ID. You can obtain the ID by calling the [ListSites](~~ListSites~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '34003500310****', 'title' => ''], ], [ - 'createdAt' => '2024-09-18T06:13:39.000Z', - 'description' => 'Error codes changed', + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable quality data collection. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], + 'type' => 'string', + 'required' => true, + 'enum' => ['on', 'off'], + 'example' => 'on', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-280B-72F8FD6DA2FE'], + ], + 'example' => '', + ], + ], + ], + '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => '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.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ], + 404 => [ + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], + 'title' => 'Modify web data quality collection configuration', + 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdatePage', - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePerformanceDataCollection'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ - 'action' => 'esa:UpdatePage', - 'authLevel' => 'resource', + 'action' => 'esa:UpdatePerformanceDataCollection', + 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['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"}]', ], 'UpdateRatePlanSpec' => [ - 'summary' => 'You can invoke UpdateRatePlanSpec to modify the Package Tier. ', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Modifies the specifications of a plan by calling UpdateRatePlanSpec.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -88293,112 +49856,87 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239593', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'Instance ID. ', - 'type' => 'string', - 'required' => false, - 'example' => 'xcdn-91fknmb80f0g', - 'title' => '', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'xcdn-91fknmb80f0g', 'title' => ''], ], [ 'name' => 'TargetPlanName', 'in' => 'query', - 'schema' => [ - 'description' => 'Target package name. ', - 'type' => 'string', - 'required' => false, - 'example' => 'basic', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the target plan.'."\n" + ."\n" + .'Alibaba Cloud China Website (www.aliyun.com)'."\n" + ."\n" + .'- Free Edition: entranceplan'."\n" + .'- Basic Edition: basic'."\n" + .'- Standard Edition: medium'."\n" + .'- Premium Edition: high'."\n" + ."\n" + .'Alibaba Cloud International Website (www.alibabacloud.com)'."\n" + ."\n" + .'- Entrance: entranceplan_intl'."\n" + .'- Pro: basicplan_intl'."\n" + .'- Premium: vipplan_intl.', 'type' => 'string', 'required' => false, 'example' => 'basic', 'title' => ''], ], [ 'name' => 'TargetPlanCode', 'in' => 'query', - 'schema' => [ - 'description' => 'Target package code. ', - 'type' => 'string', - 'required' => false, - 'example' => 'entranceplan', - 'title' => '', - ], + 'schema' => ['description' => 'The code of the target plan.'."\n" + ."\n" + .'Alibaba Cloud China Website (www.aliyun.com)'."\n" + ."\n" + .'- Free Edition: entranceplan'."\n" + .'- Basic Edition: basicplan'."\n" + .'- Standard Edition: standardplan'."\n" + .'- Premium Edition: advancedplan'."\n" + ."\n" + .'Alibaba Cloud International Website (www.alibabacloud.com)'."\n" + ."\n" + .'- Entrance: entranceplan'."\n" + .'- Pro: standardplan'."\n" + .'- Premium: advancedpla.', 'type' => 'string', 'required' => false, 'example' => 'entranceplan', 'title' => ''], ], [ 'name' => 'OrderType', 'in' => 'query', 'schema' => [ - 'description' => 'The specification update type. Valid values:'."\n" - ."\n" - .'* DOWNGRADE'."\n" - .'* UPGRADE'."\n", + 'description' => 'The type of specification change. Valid values:'."\n" + .'- UPGRADE: Upgrade.', + 'enumValueTitles' => ['UPGRADE' => 'Upgrade.'], 'type' => 'string', + 'enum' => ['UPGRADE'], 'required' => false, 'example' => 'UPGRADE', - 'enum' => [ - 'UPGRADE', - ], 'title' => '', ], ], [ 'name' => 'ChargeType', 'in' => 'query', - 'schema' => [ - 'description' => 'Billing type: '."\n" - .'- PREPAY: subscription. '."\n" - .'- POSTPAY: pay-as-you-go. ', - 'type' => 'string', - 'required' => false, - 'example' => 'PREPAY', - 'title' => '', - ], + 'schema' => ['description' => 'The billing type. Valid values:'."\n" + .'- PREPAY: Subscription.'."\n" + .'- POSTPAY: Pay-as-you-go.', 'type' => 'string', 'required' => false, 'example' => 'PREPAY', 'title' => ''], ], [ 'name' => 'AutoPay', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable auto payment.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable automatic payment.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response structure.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '30423A7F-A83D-1E24-B80E-86DD25790758'."\n", - ], - 'OrderId' => [ - 'description' => 'Order ID. ', - 'type' => 'string', - 'example' => '2223332122***', - 'title' => '', - ], - 'InstanceId' => [ - 'description' => 'Instance ID. ', - 'type' => 'string', - 'example' => 'xcdn-as23ds***', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '30423A7F-A83D-1E24-B80E-86DD25790758'."\n"], + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '2223332122***', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'xcdn-as23ds***', 'title' => ''], ], 'example' => '', ], @@ -88406,86 +49944,29 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], - [ - 'errorCode' => 'CheckPlanFailed', - 'errorMessage' => 'Invalid plan name or code. Check and try again.', - 'description' => 'Invalid plan name or code. Check and try again.', - ], - [ - '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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.', - ], - [ - 'errorCode' => 'InvalidSiteName', - 'errorMessage' => 'Invalid website name. Check and try again.', - 'description' => 'Invalid website name. Check and try again.', - ], - [ - 'errorCode' => 'SYSTEM.NoSpecificCodeFailed', - 'errorMessage' => 'Invalid subscription duration. Check and try again.', - 'description' => 'Invalid subscription duration. Check and try again.', - ], - [ - 'errorCode' => 'Order.InstanceHasUnpaidOrder', - 'errorMessage' => 'You have an unpaid order. Complete the payment or cancel the order first.', - 'description' => 'You have an unpaid order. Complete the payment or cancel the order first.', - ], - [ - 'errorCode' => 'InvalidInstance', - 'errorMessage' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.', - 'description' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.', - ], - [ - 'errorCode' => 'InsufficientBalance', - 'errorMessage' => 'Your account balance is insufficient.', - 'description' => 'Your account balance is insufficient, please recharge before purchasing.', - ], - [ - 'errorCode' => 'InsufficientAvailableQuota', - 'errorMessage' => 'Your account balance is insufficient.', - 'description' => 'Your account is in arrears, please pay the arrears before purchasing.', - ], - [ - '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' => 'The configuration for the upgrade or downgrade is not changed.', - ], - [ - 'errorCode' => 'InvalidComponent', - 'errorMessage' => 'The order parameters is invalid.', - 'description' => 'The order parameters is invalid.', - ], - [ - 'errorCode' => 'RamAuthFailed', - 'errorMessage' => 'The sub-account has no operation permission.', - 'description' => '', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['errorCode' => 'CheckPlanFailed', 'errorMessage' => 'Invalid plan name or code. Check and try again.', 'description' => 'Invalid plan name or code. Check and try again.'], + ['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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.'], + ['errorCode' => 'InvalidSiteName', 'errorMessage' => 'Invalid website name. Check and try again.', 'description' => 'Invalid website name. Check and try again.'], + ['errorCode' => 'SYSTEM.NoSpecificCodeFailed', 'errorMessage' => 'Invalid subscription duration. Check and try again.', 'description' => 'Invalid subscription duration. Check and try again.'], + ['errorCode' => 'Order.InstanceHasUnpaidOrder', 'errorMessage' => 'You have an unpaid order. Complete the payment or cancel the order first.', 'description' => 'You have an unpaid order. Complete the payment or cancel the order first.'], + ['errorCode' => 'InvalidInstance', 'errorMessage' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.', 'description' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.'], + ['errorCode' => 'InsufficientBalance', 'errorMessage' => 'Your account balance is insufficient.', 'description' => 'Your account balance is insufficient, please recharge before purchasing.'], + ['errorCode' => 'InsufficientAvailableQuota', 'errorMessage' => 'Your account balance is insufficient.', 'description' => 'Your account is in arrears, please pay the arrears before purchasing.'], + ['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' => 'The configuration for the upgrade or downgrade is not changed.'], + ['errorCode' => 'InvalidComponent', 'errorMessage' => 'The order parameters is invalid.', 'description' => 'The order parameters is invalid.'], + ['errorCode' => 'RamAuthFailed', 'errorMessage' => 'The sub-account has no operation permission.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'Package Upgrade/Downgrade ', + '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' => 'Change plan specifications', 'changeSet' => [ - [ - 'createdAt' => '2024-09-18T06:13:39.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-18T06:13:39.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateRatePlanSpec', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRatePlanSpec'], ], ], 'ramActions' => [ @@ -88496,27 +49977,16 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30423A7F-A83D-1E24-B80E-86DD25790758\\\\n\\",\\n \\"OrderId\\": \\"2223332122***\\",\\n \\"InstanceId\\": \\"xcdn-as23ds***\\"\\n}","type":"json"}]', - 'translator' => 'machine', ], 'UpdateRecord' => [ - 'summary' => 'Update DNS records, supporting multiple record types and origin authentication configuration. ', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Updates a DNS record. Various record types and origin authentication configurations are supported.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -88529,187 +49999,65 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239650', - 'abilityTreeNodes' => [ - 'FEATUREdcdnVFT29S', - ], + 'abilityTreeNodes' => ['FEATUREdcdnVFT29S'], ], 'parameters' => [ [ 'name' => 'RecordId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The ID of the record, which can be obtained by calling [ListRecords](~~2850265~~).', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the record. You can call [ListRecords](~~2850265~~) to obtain the record ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'Ttl', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The time-to-live (TTL) of the record, in seconds. The valid range is **30–86400**, or 1. When set to 1, the TTL is automatically determined.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'title' => '', - ], + 'schema' => ['description' => 'The time-to-live (TTL) of the record, in seconds. Valid values: **30 to 86400**, or 1. A value of 1 indicates that the TTL of the record is automatically determined.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'Proxied', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '', - 'description' => 'Specifies whether proxy acceleration is enabled for the record. Only CNAME and A/AAAA records support proxy acceleration. Valid values: '."\n" - .'- **true**: Enables proxy. '."\n" - .'- **false**: Disables proxy acceleration. ', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['title' => '', 'description' => 'Specifies whether to enable proxy acceleration for the record. Only CNAME records and A/AAAA records support proxy acceleration. Valid values:'."\n" + .'- **true**: Enable proxy acceleration.'."\n" + .'- **false**: Disable proxy acceleration.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'required' => false, - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The DNS type of the record, such as A/AAAA, CNAME, or TXT.', 'type' => 'string', 'required' => false, 'example' => 'A/AAAA', 'title' => ''], ], [ 'name' => 'Data', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'DNS information of the record. The content required for this field varies depending on the record type. For details, refer to the [documentation](~~2708761~~)[documentation](https://www.alibabacloud.com/help/doc-detail/2708761.html). ', - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The value or partial content of the record. This parameter is required when adding A/AAAA, CNAME, NS, MX, TXT, CAA, SRV, or URI records. Its meaning varies depending on the record type:'."\n" - ."\n" - .'- **A/AAAA**: The IP address pointed to. When multiple IP addresses are specified, separate them with commas (","). At least one IPv4 address must be provided.'."\n" - .'- **CNAME**: The target domain name pointed to.'."\n" - .'- **NS**: The name server designated for the domain.'."\n" - .'- **MX**: A valid target mail server domain name.'."\n" - .'- **TXT**: A valid text string.'."\n" - .'- **CAA**: A valid certification authority domain name.'."\n" - .'- **SRV**: A valid target host domain name.'."\n" - .'- **URI**: A valid URI string.', - 'type' => 'string', - 'required' => false, - 'example' => 'example.com', - 'title' => '', - ], - 'Priority' => [ - 'description' => 'The priority of the record, ranging from **0 to 65535**. A smaller numeric value indicates a higher priority. This parameter is required when adding MX, SRV, or URI records.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'title' => '', - ], - 'Flag' => [ - 'description' => 'The flag of the record. For CAA records, the Flag indicates its priority and processing method, with a range of **0 to 255**. This parameter is required when adding a CAA record.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '128', - 'title' => '', - ], - 'Tag' => [ - 'description' => 'The tag of the record. For CAA records, the Tag specifies its specific type and purpose. This parameter is required when adding a CAA record.', - 'type' => 'string', - 'required' => false, - 'example' => 'issue', - 'title' => '', - ], - 'Weight' => [ - 'description' => 'The weight of the record, ranging from **0 to 65535**. This parameter is required when adding SRV or URI records.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], - 'Port' => [ - 'description' => 'The port of the record, ranging from **0 to 65535**. This parameter is required when adding an SRV record.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], - 'Type' => [ - 'description' => 'The certificate type (for CERT records) or public key type (for SSHFP records). This parameter is required when adding CERT or SSHFP records.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], - 'KeyTag' => [ - 'description' => 'The public key identity of the record, ranging from **0 to 65535**. This parameter is required when adding a CERT record.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], - 'Algorithm' => [ - 'description' => 'The encryption algorithm used by the record, ranging from **0 to 255**. This field is required when adding CERT or SSHFP records.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], - 'Certificate' => [ - 'description' => 'The public key certificate information of the record. This parameter is required when adding CERT, SMIMEA, or TLSA records.', - 'type' => 'string', - 'required' => false, - 'example' => 'dGVzdGFkYWxrcw==', - 'title' => '', - ], - 'Usage' => [ - 'description' => 'Usage identifier of the record, with a range of **0~255**. This parameter is required when adding SMIMEA or TLSA records. ', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], - 'Selector' => [ - 'description' => 'The type of certificate or public key used by the record, with a range of **0–255**. This parameter is required when adding SMIMEA and TLSA records.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], - 'MatchingType' => [ - 'description' => 'The algorithm policy used by the record for matching or authenticating certificates, ranging from **0 to 255**. This parameter is required when adding SMIMEA or TLSA records.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], - 'Fingerprint' => [ - 'description' => 'Public key fingerprint value of the record. This parameter is required when adding SSHFP records. ', - 'type' => 'string', - 'required' => false, - 'example' => 'abcdef1234567890', - 'title' => '', - ], + 'description' => 'The DNS information of the record. The content varies depending on the record type. For more information, see [documentation](~~2708761~~)[documentation](https://www.alibabacloud.com/help/doc-detail/2708761.html).', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The record value or partial content. This parameter is required when you add A/AAAA, CNAME, NS, MX, TXT, CAA, SRV, or URI records. The meaning varies depending on the record type:'."\n" + ."\n" + .'- **A/AAAA**: The IP address to which the record points. Separate multiple IP addresses with commas (,). At least one IPv4 address is required.'."\n" + .'- **CNAME**: The target domain name to which the record points.'."\n" + .'- **NS**: The name server for the specified domain name.'."\n" + .'- **MX**: A valid target mail server domain name.'."\n" + .'- **TXT**: A valid text string.'."\n" + .'- **CAA**: A valid certification authority domain name.'."\n" + .'- **SRV**: A valid target host domain name.'."\n" + .'- **URI**: A valid URI string.', 'type' => 'string', 'required' => false, 'example' => 'example.com', 'title' => ''], + 'Priority' => ['description' => 'The priority of the record. Valid values: **0 to 65535**. A smaller value indicates a higher priority. This parameter is required when you add MX, SRV, or URI records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + 'Flag' => ['description' => 'The flag of the record. The Flag of a CAA record indicates its priority and processing method. Valid values: **0 to 255**. This parameter is required when you add CAA records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '128', 'title' => ''], + 'Tag' => ['description' => 'The tag of the record. The Tag of a CAA record indicates its specific type and purpose. This parameter is required when you add CAA records.', 'type' => 'string', 'required' => false, 'example' => 'issue', 'title' => ''], + 'Weight' => ['description' => 'The weight of the record. Valid values: **0 to 65535**. This parameter is required when you add SRV or URI records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'Port' => ['description' => 'The port of the record. Valid values: **0 to 65535**. This parameter is required when you add SRV records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'Type' => ['description' => 'The certificate type of the record (for CERT records) or the public key type (for SSHFP records). This parameter is required when you add CERT or SSHFP records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'KeyTag' => ['description' => 'The public key identifier of the record. Valid values: **0 to 65535**. This parameter is required when you add CERT records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'Algorithm' => ['description' => 'The encryption algorithm used by the record. Valid values: **0 to 255**. This parameter is required when you add CERT or SSHFP records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'Certificate' => ['description' => 'The public key certificate information of the record. This parameter is required when you add CERT, SMIMEA, or TLSA records.', 'type' => 'string', 'required' => false, 'example' => 'dGVzdGFkYWxrcw==', 'title' => ''], + 'Usage' => ['description' => 'The usage identifier of the record. Valid values: **0 to 255**. This parameter is required when you add SMIMEA or TLSA records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'Selector' => ['description' => 'The type of certificate or public key used by the record. Valid values: **0 to 255**. This parameter is required when you add SMIMEA or TLSA records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'MatchingType' => ['description' => 'The algorithm policy used by the record for matching or verifying certificates. Valid values: **0 to 255**. This parameter is required when you add SMIMEA or TLSA records.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'Fingerprint' => ['description' => 'The public key fingerprint value of the record. This parameter is required when you add SSHFP records.', 'type' => 'string', 'required' => false, 'example' => 'abcdef1234567890', 'title' => ''], ], 'required' => true, 'example' => '{'."\n" @@ -88721,97 +50069,52 @@ [ 'name' => 'SourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'Origin type for CNAME records. This parameter is required when adding a CNAME record. Valid values: '."\n" - ."\n" - .'- **OSS**: OSS origin. '."\n" - .'- **S3**: S3 origin. '."\n" - .'- **LB**: Server Load Balancer origin. '."\n" - .'- **OP**: Address pool origin. '."\n" - .'- **Domain**: Standard domain name origin. '."\n" - ."\n" - .'If this parameter is not specified or left empty, it defaults to Domain, indicating a standard domain name origin. ', - 'type' => 'string', - 'required' => false, - 'example' => 'OSS', - 'title' => '', - ], + 'schema' => ['description' => 'The origin server type of the CNAME record. This parameter is required when you add a CNAME record. Valid values:'."\n" + ."\n" + .'- **OSS**: OSS origin server.'."\n" + .'- **S3**: S3 origin server.'."\n" + .'- **LB**: load balancing origin server.'."\n" + .'- **OP**: IPAM pool origin server.'."\n" + .'- **Domain**: standard domain name origin server.'."\n" + ."\n" + .'If this parameter is not specified or is left empty, the default value is Domain, which indicates a standard domain name origin server type.', 'type' => 'string', 'required' => false, 'example' => 'OSS', 'title' => ''], ], [ 'name' => 'BizName', 'in' => 'query', - 'schema' => [ - 'description' => 'The business scenario for acceleration. This parameter is not required for records that do not enable acceleration. Valid values:'."\n" - .'- **video_image**: Video and image.'."\n" - .'- **api**: API.'."\n" - .'- **web**: Web page.', - 'type' => 'string', - 'required' => false, - 'example' => 'web', - 'title' => '', - ], + 'schema' => ['description' => 'The business scenario for record acceleration. This parameter is not required for records without acceleration enabled. Valid values:'."\n" + .'- **video_image**: video and image.'."\n" + .'- **api**: API.'."\n" + .'- **web**: web page.', 'type' => 'string', 'required' => false, 'example' => 'web', 'title' => ''], ], [ 'name' => 'Comment', 'in' => 'query', - 'schema' => [ - 'description' => 'Comment for the record. ', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a remark.', - 'title' => '', - ], + 'schema' => ['description' => 'The comment for the record.', 'type' => 'string', 'required' => false, 'example' => 'This is a remark.', 'title' => ''], ], [ 'name' => 'AuthConf', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'Authentication information for the origin of a CNAME record.', + 'description' => 'The origin authentication information of the CNAME record.', 'type' => 'object', 'properties' => [ - 'AuthType' => [ - 'description' => 'The origin authentication type. The supported authentication types vary depending on the origin type, which is specified by the SourceType parameter in this API. When the origin type is OSS or S3, you must specify the authentication type. Valid values:'."\n" - .'- **public**: Public-read. Select this value when the origin type is OSS or S3 and the origin is publicly readable.'."\n" - .'- **private**: Private read. Select this value when the origin type is S3 and the origin is privately readable.'."\n" - .'- **private_same_account**: Private same-account read. Select this value when the origin type is OSS, the origin is privately readable, and both the origin and the current service belong to the same Alibaba Cloud account.', - 'type' => 'string', - 'required' => false, - 'example' => 'private', - 'title' => '', - ], - 'SecretKey' => [ - 'description' => 'The SecretKey of the Alibaba Cloud account that owns the origin. This value is required when the origin type is OSS and the authentication type is private cross-account read, or when the origin type is S3 and the authentication type is private read.', - 'type' => 'string', - 'required' => false, - 'example' => 'u0Nkg5gBK*******QF5wvKMM504JUHt', - 'title' => '', - ], - 'AccessKey' => [ - 'description' => 'The AccessKey of the account to which the origin belongs. This value is required when the origin type is OSS and the origin authentication type is private cross-account read, or when the origin type is S3 and the origin authentication type is private read.', - 'type' => 'string', - 'required' => false, - 'example' => 'VIxuvJSA2S03f******kp208dy5w7', - 'title' => '', - ], - 'Region' => [ - 'description' => 'The signature algorithm version. This parameter is required when the origin type is S3 and the authentication type is private read. Supported versions:'."\n" - .'- **v2**'."\n" - .'- **v4**'."\n" - ."\n" - .'If not specified, the default value is v4.', - 'type' => 'string', - 'required' => false, - 'example' => 'v2', - 'title' => '', - ], - 'Version' => [ - 'description' => 'The region of the origin. This value is required when the origin type is S3. You can obtain the correct region from the official S3 website.', - 'type' => 'string', - 'required' => false, - 'example' => 'us-east-1', - 'title' => '', - ], + 'AuthType' => ['description' => 'The origin authentication type. Different origin server types support different authentication types. The origin server type refers to the SourceType parameter in this operation. When the origin server type is OSS or S3, you must specify the origin authentication type. Valid values:'."\n" + ."\n" + .'- **public**: public read. Select this value when the origin server type is OSS or S3 and the origin server allows public read access.'."\n" + .'- **private**: private read. Select this value when the origin server type is S3 and the origin server allows only private read access.'."\n" + .'- **private_same_account**: private same-account read. Select this value when the origin server type is OSS, the origin server is under the same Alibaba Cloud account, and the origin server allows only private read access.', 'type' => 'string', 'required' => false, 'example' => 'private', 'title' => ''], + 'SecretKey' => ['description' => 'The SecretKey of the account to which the origin server belongs. This parameter is required when the origin server type is OSS and the origin authentication type is private cross-account read, or when the origin server type is S3 and the origin authentication type is private read.', 'type' => 'string', 'required' => false, 'example' => 'u0Nkg5gBK*******QF5wvKMM504JUHt', 'title' => ''], + 'AccessKey' => ['description' => 'The AccessKey of the account to which the origin server belongs. This parameter is required when the origin server type is OSS and the origin authentication type is private cross-account read, or when the origin server type is S3 and the origin authentication type is private read.', 'type' => 'string', 'required' => false, 'example' => 'VIxuvJSA2S03f******kp208dy5w7', 'title' => ''], + 'Region' => ['description' => 'The signature algorithm version. This parameter is required when the origin server type is S3 and the origin authentication type is private read. Valid values:'."\n" + ."\n" + .'- **v2**'."\n" + ."\n" + .'- **v4**'."\n" + ."\n" + .'Default value: v4.', 'type' => 'string', 'required' => false, 'example' => 'v2', 'title' => ''], + 'Version' => ['description' => 'The region to which the origin server belongs. This parameter is required when the origin server type is S3. Obtain the region from the official S3 website.', 'type' => 'string', 'required' => false, 'example' => 'us-east-1', 'title' => ''], ], 'required' => false, 'title' => '', @@ -88822,13 +50125,14 @@ 'name' => 'HostPolicy', 'in' => 'query', 'schema' => [ - 'description' => 'The origin fetch HOST policy, which takes effect only for CNAME records. It defines the policy for including the HOST header during origin fetch. Two modes are supported:'."\n" - .'- **follow_hostname**: Follow the host record.'."\n" - .'- **follow_origin_domain**: Follow the origin domain name.', + 'description' => 'The back-to-origin HOST policy. This parameter takes effect when the record type is CNAME. Settings the HOST policy for back-to-origin requests. Valid values:'."\n" + ."\n" + .'- **follow_hostname**: follows the host record.'."\n" + .'- **follow_origin_domain**: follows the Origin Domain Name.', 'type' => 'string', + 'enum' => [], 'required' => false, 'example' => 'follow_origin_domain', - 'enum' => [], 'title' => '', ], ], @@ -88838,12 +50142,7 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID. ', - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', 'title' => ''], ], 'description' => '', 'title' => '', @@ -88853,529 +50152,148 @@ ], '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'InvalidParameter.RecordData', - 'errorMessage' => 'Invalid record content. Adjust your configurations based on the API documentation.', - 'description' => 'Invalid record content. Adjust your configurations based on the API documentation.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'Record.Reserved', - 'errorMessage' => 'Another operation on the record is in progress. Try again later.', - 'description' => 'Another operation on the record is in progress. Try again later.', - ], - [ - 'errorCode' => 'Record.ServiceBusy', - 'errorMessage' => 'The record is being configured. Try again later.', - 'description' => 'The record is being configured. Try again later.', - ], - [ - 'errorCode' => 'Record.Conflict', - 'errorMessage' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', - 'description' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'InvalidParameter.InvalidBiz', - 'errorMessage' => 'The incoming parameter value of the business type is empty or incorrect.', - 'description' => 'The incoming parameter value of the business type is empty or incorrect.', - ], - [ - 'errorCode' => 'Record.RecordValueContainSourceInBlacklist', - 'errorMessage' => 'The record value contains the blacklist address, and the details can be submitted for work order consultation.', - 'description' => 'The record value contains the blacklist address, and the details can be submitted for work order consultation.', - ], - [ - 'errorCode' => 'InvalidParameter.InvalidRecordNameSuffix', - 'errorMessage' => 'If you add other records, the suffix of the host record must be the same as the site name.', - 'description' => 'If you add another record, the suffix of the host record must be the same as the site name. Please adjust and try again.', - ], - [ - 'errorCode' => 'InvalidParameter.RecordNameExceedLimit', - 'errorMessage' => 'The length of the record name exceeds the maximum limit.', - 'description' => 'The record name cannot exceed 200 characters.', - ], - [ - 'errorCode' => 'InvalidParameter.InvalidHostPolicy', - 'errorMessage' => 'The host parameter in the origin fetch request is invalid.', - 'description' => 'The host parameter in the origin fetch request is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.CnameSiteRecordUnsupport', - 'errorMessage' => 'The current record type is not supported for a website connected by CNAME setup.', - 'description' => 'You can only add A/AAAA and CNAME records to a website connected by CNAME setup.', - ], - [ - 'errorCode' => 'InvalidParameter.RecordCommentExceedLimit', - 'errorMessage' => 'The number of incoming record comment exceeds the maximum limit.', - 'description' => 'The record comment information is greater than 50 characters.', - ], - [ - 'errorCode' => 'QuotaExceed.WildCardRecord', - 'errorMessage' => 'The number of wildcard records exceeds the plan quota. Contact the sales team to increase your quota.', - 'description' => 'The number of wildcard records exceeds the plan quota. Contact the sales team to increase your quota.', - ], - [ - 'errorCode' => 'Record.AorAAAARecordValueContainInvalidIP', - 'errorMessage' => 'The A/AAAA record value contains the invalid IP.', - 'description' => 'When creating or editing an A/AAAA record, the record value contains an invalid IP.', - ], - [ - 'errorCode' => 'Record.AorAAAARecordValueIPExceedLimit', - 'errorMessage' => 'The number of IP addresses exceeds the limit for the A/AAAA record.', - 'description' => 'When creating or editing A/AAAA records, the number of IP addresses exceeds the limit. A host record only supports 8 IPv4 and 4 IPv6 IP addresses. Please adjust and try again.', - ], - [ - 'errorCode' => 'Record.CAARecordFlagExceedLimit', - 'errorMessage' => 'The value of the flag parameter for a CAA record is out of range.', - 'description' => 'The value of the flag parameter for a CAA record is out of range while creating or editing DNS record information.', - ], - [ - 'errorCode' => 'Record.CAARecordTagExceedLimit', - 'errorMessage' => 'The CAA record tag has illegal characters other than issue, issuewild, and iodef.', - 'description' => 'When creating or editing CAA records, illegal characters other than issue, issuewild, and iodef are passed in the tag value.', - ], - [ - 'errorCode' => 'Record.CERTRecordAlgorithmExceedLimit', - 'errorMessage' => 'The value of the algorithm parameter for the CERT record is out of range.', - 'description' => 'The value of the algorithm parameter for the CERT record is out of range while creating or editing DNS record information.', - ], - [ - 'errorCode' => 'Record.CERTRecordKeyTagExceedLimit', - 'errorMessage' => 'The value of the keyTag parameter for a CERT record is out of range.', - 'description' => 'The value of the keyTag parameter for a CERT record is out of range when creating or editing DNS record information.', - ], - [ - 'errorCode' => 'Record.CERTRecordTypeExceedLimit', - 'errorMessage' => 'The CERT record type is out of range.', - 'description' => 'The CERT record type parameter was out of range when creating or editing DNS record information.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'Record.CNameRecordValueCannotEqualExistedPoolSource', - 'errorMessage' => 'The CNAME record cannot be the origin of the added source address pool. Check and try again.', - 'description' => 'The CNAME record cannot be the origin of the added source address pool. Check and try again.', - ], - [ - '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' => 'The CNAME record cannot be the origin of an added record. Check the record values of other records and try again.', - ], - [ - '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' => 'The record value of a CNAME record cannot be exactly the same as the name of another existing Layer 4 proxy record.', - ], - [ - 'errorCode' => 'Record.CNameRecordValueCannotEqualOtherExistedRecord', - 'errorMessage' => 'The record value of a CNAME record cannot be the same as the name of another existing CNAME record.', - 'description' => 'The record value of a CNAME record cannot be the same as the name of another existing CNAME record.', - ], - [ - 'errorCode' => 'Record.CNameRecordValueCannotEqualHostRecord', - 'errorMessage' => 'The record value of the CNAME record cannot be exactly the same as the host record.', - 'description' => 'The record value of the CNAME record cannot be exactly the same as the host record. Please adjust and try again.', - ], - [ - 'errorCode' => 'Record.CNameRecordValueExceedLimit', - 'errorMessage' => 'The CNAME record value cannot exceed 253 characters, please delete and try again.', - 'description' => 'The record value cannot exceed 253 characters, please delete and try again.', - ], - [ - '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' => '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.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'Record.EmptyRecordValue', - 'errorMessage' => 'The record value is empty, please fill it in correctly and try again.', - 'description' => 'The record value is empty, please fill it in correctly and try again.', - ], - [ - 'errorCode' => 'Record.InvalidCertEncodeWithCERTRecord', - 'errorMessage' => 'The certificate value of the CERT record is not base64-encoded.', - 'description' => 'When you create or edit CERT record information, the certificate value of the CERT record is not base64-encoded.', - ], - [ - 'errorCode' => 'Record.InvalidFingerprintWithSSHFPRecord', - 'errorMessage' => 'The SSHFP record fingerprint value is not hexadecimal encoded.', - 'description' => 'When creating or editing SSHFP record information, the fingerprint value is not hexadecimal encoded.', - ], - [ - 'errorCode' => 'Record.InvalidIssueDataWithCAARecordTag', - 'errorMessage' => 'The tag of a CAA record can only be a semicolon or a valid domain name separated by semicolons.', - 'description' => 'When creating or editing CAA record information, the tag tag of a CAA record can only be a semicolon or a valid domain name separated by semicolons.', - ], - [ - 'errorCode' => 'Record.InvalidMailAddressWithCAARecordTag', - 'errorMessage' => 'The CAA record tag is prefixed with mailto:, it must be followed by a legal email address.', - 'description' => 'When creating or editing CAA record information, when Tag is iodef and Value is prefixed with mailto:, it must be followed by a legal email address.', - ], - [ - 'errorCode' => 'Record.InvalidSmimeaEncodeWithSMIMEARecord', - 'errorMessage' => 'The certificate value of the SMIMEA record is not base64-encoded.', - 'description' => 'When creating or editing SMIMEA record information, the certificate value of the SMIMEA record is not base64-encoded.', - ], - [ - 'errorCode' => 'Record.InvalidTslaEncodeWithTSLARecord', - 'errorMessage' => 'The certificate value passed in is not hexadecimal encoded with TSLA record.', - 'description' => 'When creating or editing TLSA record information, the certificate value passed in is not hexadecimal encoded.', - ], - [ - 'errorCode' => 'Record.InvalidURLWithURIRecord', - 'errorMessage' => 'The URI record value must be a valid URL address.', - 'description' => 'When creating or editing URI record information, the record value must be a valid URL address.', - ], - [ - 'errorCode' => 'Record.NoRecordNameConflictWithNSRecord', - 'errorMessage' => 'No record name can conflict with an NS record name.', - 'description' => 'No record name can conflict with an NS record name.', - ], - [ - 'errorCode' => 'Record.NSRecordCannotEqualSiteName', - 'errorMessage' => 'An NS record with the exact same name as the site name is not allowed.', - 'description' => 'Adding an NS record with the exact same name as the site name is not allowed.', - ], - [ - 'errorCode' => 'Record.OSSSourceInvalidAuthType', - 'errorMessage' => 'The recorded OSS origin station authentication type is not supported.', - 'description' => 'The recorded OSS origin station authentication type is not supported.', - ], - [ - 'errorCode' => 'Record.ParseJSONRecordValueFailed', - 'errorMessage' => 'The JSON data format of the record data is incorrect. Please adjust and try again.', - 'description' => 'The JSON data format of the record data is incorrect. Please adjust and try again.', - ], - [ - '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' => 'If the source station type of the record is source address pool, the input source address pool does not exist.', - ], - [ - 'errorCode' => 'Record.RecordNameConflictForSpecifiedRecordType', - 'errorMessage' => 'The A/AAAA and CNAME records cannot have the same name.', - 'description' => 'The A/AAAA and CNAME records cannot have the same name.', - ], - [ - 'errorCode' => 'Record.RecordNameConflictWithIPAName', - 'errorMessage' => 'The record name cannot have the same name as the Layer 4 proxy record.', - 'description' => 'When you create or edit DNS record information, the record name cannot have the same name as the Layer 4 proxy record.', - ], - [ - 'errorCode' => 'Record.RecordNameConflictWithLBName', - 'errorMessage' => 'The record name cannot be the same as the Server Load Balancer record name.', - 'description' => 'When creating or editing DNS record information, the record name cannot be the same as the Server Load Balancer record name.', - ], - [ - 'errorCode' => 'Record.RecordNameConflictWithNSRecord', - 'errorMessage' => 'The NS record name cannot be the same as any other type of record name.', - 'description' => 'When creating or editing DNS record information, the NS record name cannot be the same as any other type of record name.', - ], - [ - 'errorCode' => 'Record.RecordNameConflictWithPoolName', - 'errorMessage' => 'The record name cannot be the same as the source address pool record name.', - 'description' => 'When creating or editing DNS record information, the record name cannot be the same as the source address pool record name.', - ], - [ - 'errorCode' => 'Record.RecordNameInBlacklist', - 'errorMessage' => 'The record name is in blacklist.', - 'description' => 'The record name is in the blacklist and cannot be added.', - ], - [ - 'errorCode' => 'Record.S3SourceInvalidAuthRegion', - 'errorMessage' => 'The recorded S3 origin belongs to a region that is not in the supported range.', - 'description' => 'The recorded S3 origin belongs to a region that is not in the supported range.', - ], - [ - 'errorCode' => 'Record.S3SourceInvalidAuthType', - 'errorMessage' => 'The recorded S3 origin authentication type is not supported.', - 'description' => 'The recorded S3 origin authentication type is not supported.', - ], - [ - 'errorCode' => 'Record.S3SourceInvalidAuthVersion', - 'errorMessage' => 'The version of the authentication signature algorithm of the S3 origin is not supported.', - 'description' => 'The version of the authentication signature algorithm of the S3 origin is not supported.', - ], - [ - 'errorCode' => 'Record.SourceAccessKeyExceedLimit', - 'errorMessage' => 'The character length of the AccessKey parameter value for the record source station is out of range.', - 'description' => 'The character length of the AccessKey parameter value for the record source station is out of range.', - ], - [ - 'errorCode' => 'Record.SourceEmptyAK', - 'errorMessage' => 'The AccessKey of the account to which the origin site belongs is empty.', - 'description' => 'The AccessKey of the account to which the origin site belongs is empty.', - ], - [ - 'errorCode' => 'Record.SourceEmptyAuthConf', - 'errorMessage' => 'The authentication information of the origin station is empty.', - 'description' => 'The recorded authentication information of the origin station is empty.', - ], - [ - 'errorCode' => 'Record.SourceEmptySecretKey', - 'errorMessage' => 'The SecretKey of the account to which the recorded origin site belongs is empty.', - 'description' => 'The SecretKey of the account to which the recorded origin site belongs is empty.', - ], - [ - 'errorCode' => 'Record.SourceSecretKeyExceedLimit', - 'errorMessage' => 'The character length of the SecretKey parameter value for the record source station is out of range.', - 'description' => 'The character length of the SecretKey parameter value for the record source station is out of range.', - ], - [ - '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 host record name is not valid. The SRV host record name must begin with an underscore (-), followed by a lowercase letter (a-z), number (0-9), hyphen (-), followed by any character, followed by an underscore (-) and a lowercase letter, number, or hyphen.', - ], - [ - 'errorCode' => 'Record.SRVRecordPortExceedLimit', - 'errorMessage' => 'The SRV record port is out of range.', - 'description' => 'When creating or editing DNS record information, the SRV record port filled in is out of range.', - ], - [ - 'errorCode' => 'Record.SSHFPRecordAlgorithmExceedLimit', - 'errorMessage' => 'The algorithm parameter value for the SSHFP record is out of range.', - 'description' => 'The algorithm parameter value for the SSHFP record is out of range while creating or editing DNS record information.', - ], - [ - 'errorCode' => 'Record.TTLExceedLimit', - 'errorMessage' => 'The TTL parameter value for a record is out of range.', - 'description' => 'The TTL parameter value for a record is out of range while creating or editing DNS record information.', - ], - [ - 'errorCode' => 'Record.TXTRecordValueExceedLimit', - 'errorMessage' => 'The TXT record value cannot exceed 450 characters.', - 'description' => 'When you create or edit DNS record information, the TXT record value cannot exceed 450 characters.', - ], - [ - 'errorCode' => 'Record.TypeExceedLimitWithSSHFPRecord', - 'errorMessage' => 'The SSHFP record Type parameter value is out of range.', - 'description' => 'The SSHFP record Type parameter value is out of range while creating or editing DNS record information.', - ], - [ - 'errorCode' => 'Record.UnmatchedRecordNameContainDoubleConsecutiveDot', - 'errorMessage' => 'Illegal host record name. The host record cannot contain consecutive dot.', - 'description' => 'Illegal host record name. The host record cannot contain consecutive dot.', - ], - [ - 'errorCode' => 'Record.UnmatchedRecordNameForbidStarSev', - 'errorMessage' => 'Illegal host record name, SRV record name disallowed asterisk.', - 'description' => 'Illegal host record name, SRV record name disallowed asterisk.', - ], - [ - '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' => 'Illegal host record name. The \'@\' symbol can only appear at the top of the host record and can only be followed. Symbol, other strings are not allowed.', - ], - [ - 'errorCode' => 'Record.UnmatchedRecordNameInvalidNamePrefixSuffix', - 'errorMessage' => 'Illegal host record name. Host record values cannot start or end with a dot, a hyphens.', - 'description' => 'Illegal host record name. Host record values cannot start or end with a dot, a hyphens.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'Record.UnmatchedRecordNameSeperateStringTooLarge', - 'errorMessage' => 'Illegal host record name. The number of characters in each segment separated by dot cannot exceed 63.', - 'description' => 'Illegal host record name. The number of characters in each segment separated by \'.\' cannot exceed 63.', - ], - [ - 'errorCode' => 'Record.UnsupportedSourceType', - 'errorMessage' => 'The recorded source station type is not in the supported range.', - 'description' => 'The recorded source station type is not in the supported range.', - ], - [ - 'errorCode' => 'Record.UnsupportedType', - 'errorMessage' => 'The record type parameter is unsupported.', - 'description' => 'The record type parameter is incorrect. Please check the record type parameter.', - ], - [ - 'errorCode' => 'Record.ValidProxiedForSpecifedRecordType', - 'errorMessage' => 'Only A/AAAA and CNAME types support proxy acceleration.', - 'description' => 'When creating or editing a record, proxy acceleration is enabled in the proxy state. Only A/AAAA and CNAME types support proxy acceleration.', - ], - [ - 'errorCode' => 'Record.RecordUsageExceedLimit', - 'errorMessage' => 'The usage parameter value filled in is out of range.', - 'description' => 'When creating or editing DNS record information, the usage parameter value filled in is out of range.', - ], - [ - 'errorCode' => 'Record.RecordSelectorExceedLimit', - 'errorMessage' => 'The selector parameter value filled in is out of range.', - 'description' => 'While creating or editing DNS record information, the selector parameter value filled in is out of range.', - ], - [ - 'errorCode' => 'Record.RecordMatchingTypeExceedLimit', - 'errorMessage' => 'The matchingType parameter value filled in is out of range.', - 'description' => 'While creating or editing DNS record information, the matchingType parameter value filled in is out of range.', - ], - [ - 'errorCode' => 'Record.RecordPriorityExceedLimit', - 'errorMessage' => 'The record priority parameter value filled in is out of range.', - 'description' => 'When creating or editing DNS record information, the record priority parameter value filled in is out of range.', - ], - [ - 'errorCode' => 'Record.RecordWeightExceedLimit', - 'errorMessage' => 'The record weight parameter value filled in is out of range.', - 'description' => 'When creating or editing DNS record information, the record weight parameter value filled in is out of range.', - ], - [ - 'errorCode' => 'Record.RecordNameConflictWithSameRecordType', - 'errorMessage' => 'Record conflicts with an existing host record that has the same name and value.', - 'description' => 'Record conflicts with an existing host record that has the same name and value.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'InvalidParameter.CnameSiteRecordNoProxied', - 'errorMessage' => 'A non-proxied record was added for a website using a CNAME setup.', - 'description' => 'A non-proxied record was added for a website using a CNAME setup.', - ], - [ - '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' => 'The host record value cannot exist separately in various symbols, and can be added with any lowercase letters or numbers.'."\n", - ], - [ - 'errorCode' => 'Record.InvalidIodefDataWithCAARecordTag', - 'errorMessage' => 'The CAA record Tag value cannot start with mailto: or http:// or https.', - 'description' => 'When creating or editing CAA record information, the Tag value cannot start with mailto: http:// or 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 records cannot add all and asterisk prefixed records at the same time.', - ], - [ - 'errorCode' => 'InvalidParameter.PrivateIpAsSourceUnsupported', - 'errorMessage' => 'The provided source is an invalid private IP address. Please verify and resubmit.', - 'description' => 'The provided source is an invalid private IP address. Please verify and resubmit.', - ], - [ - 'errorCode' => 'InvalidParameter.SourceIpInBlacklist', - 'errorMessage' => 'The provided source is an invalid private IP address. Please verify and resubmit.', - 'description' => 'The provided source is an invalid private IP address. Please verify and resubmit.', - ], - [ - 'errorCode' => 'SameNameRecordExceedLimit', - 'errorMessage' => 'The number of records with the same name exceeds the upper limit.', - 'description' => 'The number of records with the same name exceeds the upper limit.', - ], - [ - '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' => 'Illegal host record character. Only lowercase a-z, uppercase A- Z, digits 0-9, \'-\', \'_\', \'.\', \'*\', and \'@\' are supported as valid characters in host records \',\' @ \'.'."\n", - ], - [ - 'errorCode' => 'Record.InvalidHTTPURLValueWithCAARecordTag', - 'errorMessage' => 'The CAA record is prefixed with http:// or https://, it must be followed by a valid URL.', - 'description' => 'When you create or edit a CAA record, if the Tag is `iodef` and the Value starts with `http://` or `https://`, it must be followed by a valid URL.', - ], - [ - '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' => '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.', - ], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => '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.'], + ['errorCode' => 'InvalidParameter.RecordData', 'errorMessage' => 'Invalid record content. Adjust your configurations based on the API documentation.', 'description' => 'Invalid record content. Adjust your configurations based on the API documentation.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'Record.Reserved', 'errorMessage' => 'Another operation on the record is in progress. Try again later.', 'description' => 'Another operation on the record is in progress. Try again later.'], + ['errorCode' => 'Record.ServiceBusy', 'errorMessage' => 'The record is being configured. Try again later.', 'description' => 'The record is being configured. Try again later.'], + ['errorCode' => 'Record.Conflict', 'errorMessage' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', 'description' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.'], + ['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' => '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.'], + ['errorCode' => 'InvalidParameter.InvalidBiz', 'errorMessage' => 'The incoming parameter value of the business type is empty or incorrect.', 'description' => 'The incoming parameter value of the business type is empty or incorrect.'], + ['errorCode' => 'Record.RecordValueContainSourceInBlacklist', 'errorMessage' => 'The record value contains the blacklist address, and the details can be submitted for work order consultation.', 'description' => 'The record value contains the blacklist address, and the details can be submitted for work order consultation.'], + ['errorCode' => 'InvalidParameter.InvalidRecordNameSuffix', 'errorMessage' => 'If you add other records, the suffix of the host record must be the same as the site name.', 'description' => 'If you add another record, the suffix of the host record must be the same as the site name. Please adjust and try again.'], + ['errorCode' => 'InvalidParameter.RecordNameExceedLimit', 'errorMessage' => 'The length of the record name exceeds the maximum limit.', 'description' => 'The record name cannot exceed 200 characters.'], + ['errorCode' => 'InvalidParameter.InvalidHostPolicy', 'errorMessage' => 'The host parameter in the origin fetch request is invalid.', 'description' => 'The host parameter in the origin fetch request is invalid.'], + ['errorCode' => 'InvalidParameter.CnameSiteRecordUnsupport', 'errorMessage' => 'The current record type is not supported for a website connected by CNAME setup.', 'description' => 'You can only add A/AAAA and CNAME records to a website connected by CNAME setup.'], + ['errorCode' => 'InvalidParameter.RecordCommentExceedLimit', 'errorMessage' => 'The number of incoming record comment exceeds the maximum limit.', 'description' => 'The record comment information is greater than 50 characters.'], + ['errorCode' => 'QuotaExceed.WildCardRecord', 'errorMessage' => 'The number of wildcard records exceeds the plan quota. Contact the sales team to increase your quota.', 'description' => 'The number of wildcard records exceeds the plan quota. Contact the sales team to increase your quota.'], + ['errorCode' => 'Record.AorAAAARecordValueContainInvalidIP', 'errorMessage' => 'The A/AAAA record value contains the invalid IP.', 'description' => 'When creating or editing an A/AAAA record, the record value contains an invalid IP.'], + ['errorCode' => 'Record.AorAAAARecordValueIPExceedLimit', 'errorMessage' => 'The number of IP addresses exceeds the limit for the A/AAAA record.', 'description' => 'When creating or editing A/AAAA records, the number of IP addresses exceeds the limit. A host record only supports 8 IPv4 and 4 IPv6 IP addresses. Please adjust and try again.'], + ['errorCode' => 'Record.CAARecordFlagExceedLimit', 'errorMessage' => 'The value of the flag parameter for a CAA record is out of range.', 'description' => 'The value of the flag parameter for a CAA record is out of range while creating or editing DNS record information.'], + ['errorCode' => 'Record.CAARecordTagExceedLimit', 'errorMessage' => 'The CAA record tag has illegal characters other than issue, issuewild, and iodef.', 'description' => 'When creating or editing CAA records, illegal characters other than issue, issuewild, and iodef are passed in the tag value.'], + ['errorCode' => 'Record.CERTRecordAlgorithmExceedLimit', 'errorMessage' => 'The value of the algorithm parameter for the CERT record is out of range.', 'description' => 'The value of the algorithm parameter for the CERT record is out of range while creating or editing DNS record information.'], + ['errorCode' => 'Record.CERTRecordKeyTagExceedLimit', 'errorMessage' => 'The value of the keyTag parameter for a CERT record is out of range.', 'description' => 'The value of the keyTag parameter for a CERT record is out of range when creating or editing DNS record information.'], + ['errorCode' => 'Record.CERTRecordTypeExceedLimit', 'errorMessage' => 'The CERT record type is out of range.', 'description' => 'The CERT record type parameter was out of range when creating or editing DNS record information.'], + ['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' => '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.'], + ['errorCode' => 'Record.CNameRecordValueCannotEqualExistedPoolSource', 'errorMessage' => 'The CNAME record cannot be the origin of the added source address pool. Check and try again.', 'description' => 'The CNAME record cannot be the origin of the added source address pool. Check and try again.'], + ['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' => 'The CNAME record cannot be the origin of an added record. Check the record values of other records and try again.'], + ['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' => 'The record value of a CNAME record cannot be exactly the same as the name of another existing Layer 4 proxy record.'], + ['errorCode' => 'Record.CNameRecordValueCannotEqualOtherExistedRecord', 'errorMessage' => 'The record value of a CNAME record cannot be the same as the name of another existing CNAME record.', 'description' => 'The record value of a CNAME record cannot be the same as the name of another existing CNAME record.'], + ['errorCode' => 'Record.CNameRecordValueCannotEqualHostRecord', 'errorMessage' => 'The record value of the CNAME record cannot be exactly the same as the host record.', 'description' => 'The record value of the CNAME record cannot be exactly the same as the host record. Please adjust and try again.'], + ['errorCode' => 'Record.CNameRecordValueExceedLimit', 'errorMessage' => 'The CNAME record value cannot exceed 253 characters, please delete and try again.', 'description' => 'The record value cannot exceed 253 characters, please delete and try again.'], + ['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' => '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.'], + ['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' => '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.'], + ['errorCode' => 'Record.EmptyRecordValue', 'errorMessage' => 'The record value is empty, please fill it in correctly and try again.', 'description' => 'The record value is empty, please fill it in correctly and try again.'], + ['errorCode' => 'Record.InvalidCertEncodeWithCERTRecord', 'errorMessage' => 'The certificate value of the CERT record is not base64-encoded.', 'description' => 'When you create or edit CERT record information, the certificate value of the CERT record is not base64-encoded.'], + ['errorCode' => 'Record.InvalidFingerprintWithSSHFPRecord', 'errorMessage' => 'The SSHFP record fingerprint value is not hexadecimal encoded.', 'description' => 'When creating or editing SSHFP record information, the fingerprint value is not hexadecimal encoded.'], + ['errorCode' => 'Record.InvalidIssueDataWithCAARecordTag', 'errorMessage' => 'The tag of a CAA record can only be a semicolon or a valid domain name separated by semicolons.', 'description' => 'When creating or editing CAA record information, the tag tag of a CAA record can only be a semicolon or a valid domain name separated by semicolons.'], + ['errorCode' => 'Record.InvalidMailAddressWithCAARecordTag', 'errorMessage' => 'The CAA record tag is prefixed with mailto:, it must be followed by a legal email address.', 'description' => 'When creating or editing CAA record information, when Tag is iodef and Value is prefixed with mailto:, it must be followed by a legal email address.'], + ['errorCode' => 'Record.InvalidSmimeaEncodeWithSMIMEARecord', 'errorMessage' => 'The certificate value of the SMIMEA record is not base64-encoded.', 'description' => 'When creating or editing SMIMEA record information, the certificate value of the SMIMEA record is not base64-encoded.'], + ['errorCode' => 'Record.InvalidTslaEncodeWithTSLARecord', 'errorMessage' => 'The certificate value passed in is not hexadecimal encoded with TSLA record.', 'description' => 'When creating or editing TLSA record information, the certificate value passed in is not hexadecimal encoded.'], + ['errorCode' => 'Record.InvalidURLWithURIRecord', 'errorMessage' => 'The URI record value must be a valid URL address.', 'description' => 'When creating or editing URI record information, the record value must be a valid URL address.'], + ['errorCode' => 'Record.NoRecordNameConflictWithNSRecord', 'errorMessage' => 'No record name can conflict with an NS record name.', 'description' => 'No record name can conflict with an NS record name.'], + ['errorCode' => 'Record.NSRecordCannotEqualSiteName', 'errorMessage' => 'An NS record with the exact same name as the site name is not allowed.', 'description' => 'Adding an NS record with the exact same name as the site name is not allowed.'], + ['errorCode' => 'Record.OSSSourceInvalidAuthType', 'errorMessage' => 'The recorded OSS origin station authentication type is not supported.', 'description' => 'The recorded OSS origin station authentication type is not supported.'], + ['errorCode' => 'Record.ParseJSONRecordValueFailed', 'errorMessage' => 'The JSON data format of the record data is incorrect. Please adjust and try again.', 'description' => 'The JSON data format of the record data is incorrect. Please adjust and try again.'], + ['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' => 'If the source station type of the record is source address pool, the input source address pool does not exist.'], + ['errorCode' => 'Record.RecordNameConflictForSpecifiedRecordType', 'errorMessage' => 'The A/AAAA and CNAME records cannot have the same name.', 'description' => 'The A/AAAA and CNAME records cannot have the same name.'], + ['errorCode' => 'Record.RecordNameConflictWithIPAName', 'errorMessage' => 'The record name cannot have the same name as the Layer 4 proxy record.', 'description' => 'When you create or edit DNS record information, the record name cannot have the same name as the Layer 4 proxy record.'], + ['errorCode' => 'Record.RecordNameConflictWithLBName', 'errorMessage' => 'The record name cannot be the same as the Server Load Balancer record name.', 'description' => 'When creating or editing DNS record information, the record name cannot be the same as the Server Load Balancer record name.'], + ['errorCode' => 'Record.RecordNameConflictWithNSRecord', 'errorMessage' => 'The NS record name cannot be the same as any other type of record name.', 'description' => 'When creating or editing DNS record information, the NS record name cannot be the same as any other type of record name.'], + ['errorCode' => 'Record.RecordNameConflictWithPoolName', 'errorMessage' => 'The record name cannot be the same as the source address pool record name.', 'description' => 'When creating or editing DNS record information, the record name cannot be the same as the source address pool record name.'], + ['errorCode' => 'Record.RecordNameInBlacklist', 'errorMessage' => 'The record name is in blacklist.', 'description' => 'The record name is in the blacklist and cannot be added.'], + ['errorCode' => 'Record.S3SourceInvalidAuthRegion', 'errorMessage' => 'The recorded S3 origin belongs to a region that is not in the supported range.', 'description' => 'The recorded S3 origin belongs to a region that is not in the supported range.'], + ['errorCode' => 'Record.S3SourceInvalidAuthType', 'errorMessage' => 'The recorded S3 origin authentication type is not supported.', 'description' => 'The recorded S3 origin authentication type is not supported.'], + ['errorCode' => 'Record.S3SourceInvalidAuthVersion', 'errorMessage' => 'The version of the authentication signature algorithm of the S3 origin is not supported.', 'description' => 'The version of the authentication signature algorithm of the S3 origin is not supported.'], + ['errorCode' => 'Record.SourceAccessKeyExceedLimit', 'errorMessage' => 'The character length of the AccessKey parameter value for the record source station is out of range.', 'description' => 'The character length of the AccessKey parameter value for the record source station is out of range.'], + ['errorCode' => 'Record.SourceEmptyAK', 'errorMessage' => 'The AccessKey of the account to which the origin site belongs is empty.', 'description' => 'The AccessKey of the account to which the origin site belongs is empty.'], + ['errorCode' => 'Record.SourceEmptyAuthConf', 'errorMessage' => 'The authentication information of the origin station is empty.', 'description' => 'The recorded authentication information of the origin station is empty.'], + ['errorCode' => 'Record.SourceEmptySecretKey', 'errorMessage' => 'The SecretKey of the account to which the recorded origin site belongs is empty.', 'description' => 'The SecretKey of the account to which the recorded origin site belongs is empty.'], + ['errorCode' => 'Record.SourceSecretKeyExceedLimit', 'errorMessage' => 'The character length of the SecretKey parameter value for the record source station is out of range.', 'description' => 'The character length of the SecretKey parameter value for the record source station is out of range.'], + ['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 host record name is not valid. The SRV host record name must begin with an underscore (-), followed by a lowercase letter (a-z), number (0-9), hyphen (-), followed by any character, followed by an underscore (-) and a lowercase letter, number, or hyphen.'], + ['errorCode' => 'Record.SRVRecordPortExceedLimit', 'errorMessage' => 'The SRV record port is out of range.', 'description' => 'When creating or editing DNS record information, the SRV record port filled in is out of range.'], + ['errorCode' => 'Record.SSHFPRecordAlgorithmExceedLimit', 'errorMessage' => 'The algorithm parameter value for the SSHFP record is out of range.', 'description' => 'The algorithm parameter value for the SSHFP record is out of range while creating or editing DNS record information.'], + ['errorCode' => 'Record.TTLExceedLimit', 'errorMessage' => 'The TTL parameter value for a record is out of range.', 'description' => 'The TTL parameter value for a record is out of range while creating or editing DNS record information.'], + ['errorCode' => 'Record.TXTRecordValueExceedLimit', 'errorMessage' => 'The TXT record value cannot exceed 450 characters.', 'description' => 'When you create or edit DNS record information, the TXT record value cannot exceed 450 characters.'], + ['errorCode' => 'Record.TypeExceedLimitWithSSHFPRecord', 'errorMessage' => 'The SSHFP record Type parameter value is out of range.', 'description' => 'The SSHFP record Type parameter value is out of range while creating or editing DNS record information.'], + ['errorCode' => 'Record.UnmatchedRecordNameContainDoubleConsecutiveDot', 'errorMessage' => 'Illegal host record name. The host record cannot contain consecutive dot.', 'description' => 'Illegal host record name. The host record cannot contain consecutive dot.'], + ['errorCode' => 'Record.UnmatchedRecordNameForbidStarSev', 'errorMessage' => 'Illegal host record name, SRV record name disallowed asterisk.', 'description' => 'Illegal host record name, SRV record name disallowed asterisk.'], + ['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' => 'Illegal host record name. The \'@\' symbol can only appear at the top of the host record and can only be followed. Symbol, other strings are not allowed.'], + ['errorCode' => 'Record.UnmatchedRecordNameInvalidNamePrefixSuffix', 'errorMessage' => 'Illegal host record name. Host record values cannot start or end with a dot, a hyphens.', 'description' => 'Illegal host record name. Host record values cannot start or end with a dot, a hyphens.'], + ['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' => '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.'], + ['errorCode' => 'Record.UnmatchedRecordNameSeperateStringTooLarge', 'errorMessage' => 'Illegal host record name. The number of characters in each segment separated by dot cannot exceed 63.', 'description' => 'Illegal host record name. The number of characters in each segment separated by \'.\' cannot exceed 63.'], + ['errorCode' => 'Record.UnsupportedSourceType', 'errorMessage' => 'The recorded source station type is not in the supported range.', 'description' => 'The recorded source station type is not in the supported range.'], + ['errorCode' => 'Record.UnsupportedType', 'errorMessage' => 'The record type parameter is unsupported.', 'description' => 'The record type parameter is incorrect. Please check the record type parameter.'], + ['errorCode' => 'Record.ValidProxiedForSpecifedRecordType', 'errorMessage' => 'Only A/AAAA and CNAME types support proxy acceleration.', 'description' => 'When creating or editing a record, proxy acceleration is enabled in the proxy state. Only A/AAAA and CNAME types support proxy acceleration.'], + ['errorCode' => 'Record.RecordUsageExceedLimit', 'errorMessage' => 'The usage parameter value filled in is out of range.', 'description' => 'When creating or editing DNS record information, the usage parameter value filled in is out of range.'], + ['errorCode' => 'Record.RecordSelectorExceedLimit', 'errorMessage' => 'The selector parameter value filled in is out of range.', 'description' => 'While creating or editing DNS record information, the selector parameter value filled in is out of range.'], + ['errorCode' => 'Record.RecordMatchingTypeExceedLimit', 'errorMessage' => 'The matchingType parameter value filled in is out of range.', 'description' => 'While creating or editing DNS record information, the matchingType parameter value filled in is out of range.'], + ['errorCode' => 'Record.RecordPriorityExceedLimit', 'errorMessage' => 'The record priority parameter value filled in is out of range.', 'description' => 'When creating or editing DNS record information, the record priority parameter value filled in is out of range.'], + ['errorCode' => 'Record.RecordWeightExceedLimit', 'errorMessage' => 'The record weight parameter value filled in is out of range.', 'description' => 'When creating or editing DNS record information, the record weight parameter value filled in is out of range.'], + ['errorCode' => 'Record.RecordNameConflictWithSameRecordType', 'errorMessage' => 'Record conflicts with an existing host record that has the same name and value.', 'description' => 'Record conflicts with an existing host record that has the same name and value.'], + ['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' => '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.'], + ['errorCode' => 'InvalidParameter.CnameSiteRecordNoProxied', 'errorMessage' => 'A non-proxied record was added for a website using a CNAME setup.', 'description' => 'A non-proxied record was added for a website using a CNAME setup.'], + ['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' => 'The host record value cannot exist separately in various symbols, and can be added with any lowercase letters or numbers.'."\n"], + ['errorCode' => 'Record.InvalidIodefDataWithCAARecordTag', 'errorMessage' => 'The CAA record Tag value cannot start with mailto: or http:// or https.', 'description' => 'When creating or editing CAA record information, the Tag value cannot start with mailto: http:// or 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 records cannot add all and asterisk prefixed records at the same time.'], + ['errorCode' => 'InvalidParameter.PrivateIpAsSourceUnsupported', 'errorMessage' => 'The provided source is an invalid private IP address. Please verify and resubmit.', 'description' => 'The provided source is an invalid private IP address. Please verify and resubmit.'], + ['errorCode' => 'InvalidParameter.SourceIpInBlacklist', 'errorMessage' => 'The provided source is an invalid private IP address. Please verify and resubmit.', 'description' => 'The provided source is an invalid private IP address. Please verify and resubmit.'], + ['errorCode' => 'SameNameRecordExceedLimit', 'errorMessage' => 'The number of records with the same name exceeds the upper limit.', 'description' => 'The number of records with the same name exceeds the upper limit.'], + ['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' => 'Illegal host record character. Only lowercase a-z, uppercase A- Z, digits 0-9, \'-\', \'_\', \'.\', \'*\', and \'@\' are supported as valid characters in host records \',\' @ \'.'."\n"], + ['errorCode' => 'Record.InvalidHTTPURLValueWithCAARecordTag', 'errorMessage' => 'The CAA record is prefixed with http:// or https://, it must be followed by a valid URL.', 'description' => 'When you create or edit a CAA record, if the Tag is `iodef` and the Value starts with `http://` or `https://`, it must be followed by a valid URL.'], + ['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' => '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.'], ], 404 => [ - [ - 'errorCode' => 'Record.NotFound', - 'errorMessage' => 'The record does not exist. Check your configurations and try again.', - 'description' => 'The record does not exist. Check your configurations and try again.', - ], + ['errorCode' => 'Record.NotFound', 'errorMessage' => 'The record does not exist. Check your configurations and try again.', 'description' => 'The record does not exist. Check your configurations and try again.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'title' => 'Update DNS Record ', - 'description' => 'This API allows you to update DNS records, including but not limited to A/AAAA, CNAME, NS, MX, TXT, CAA, SRV, and URI records. You can modify record content by passing corresponding fields such as value, priority, and flags. For CNAME records pointing to origins that require authentication (such as OSS or S3), the API also supports configuring origin authentication information to ensure secure access.'."\n" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', + 'title' => 'Update a DNS record', + 'description' => 'This API operation allows you to update a DNS record, including but not limited to A/AAAA, CNAME, NS, MX, TXT, CAA, SRV, and URI record types. You can modify the record content by specifying the corresponding record value, priority, flag, and other fields. For CNAME origin servers that require authentication, such as OSS and S3, this API operation also supports configuring origin authentication information to ensure secure access.'."\n" ."\n" - .'### Notes'."\n" + .'### Before you begin'."\n" ."\n" - .'- The record value must match the record type; for example, a CNAME record must specify a target domain name.'."\n" - .'- Certain record types (such as MX and SRV) require a Priority value.'."\n" + .'- The record value (Value) must match the record type. For example, a CNAME record must correspond to a target domain name.'."\n" + .'- Certain record types, such as MX and SRV, require a priority (Priority) value.'."\n" .'- CAA records require specific fields such as Flag and Tag.'."\n" - .'- When updating security-related records such as CERT and SSHFP, you must accurately configure fields like Type and Algorithm.'."\n" - .'- When using OSS or S3 as the origin, provide authentication details in AuthConf based on Permission Configuration.'."\n", - 'requestParamsDescription' => 'The Data field of the record contains the DNS information of the record. The content required for this field varies depending on the record type. For details, refer to the [documentation](https://help.aliyun.com/document_detail/2708761.html)[documentation](https://www.alibabacloud.com/help/doc-detail/2708761.html). ', + .'- When updating security records such as CERT and SSHFP, accurately set the Type, Algorithm, and other fields.'."\n" + .'- When using OSS or S3 as the origin server, configure the authentication details in AuthConf based on the permission settings.', + 'requestParamsDescription' => 'The Data field of the record contains the DNS information of the record. The content varies depending on the record type. For more information, see [documentation](https://help.aliyun.com/document_detail/2708761.html)[documentation](https://www.alibabacloud.com/help/doc-detail/2708761.html).', 'changeSet' => [ - [ - 'createdAt' => '2025-06-10T06:18:46.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-10-10T12:01:10.000Z', - 'description' => 'Error codes changed, Request parameters changed', - ], - [ - 'createdAt' => '2024-09-24T08:28:18.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-23T08:53:22.000Z', - 'description' => 'Error codes changed, Request parameters changed', - ], + ['createdAt' => '2025-06-10T06:18:46.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-10-10T12:01:10.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2024-09-24T08:28:18.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-23T08:53:22.000Z', 'description' => 'Error codes changed, Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '10', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateRecord', + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRecord'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', ], 'UpdateRedirectRule' => [ - 'summary' => 'Update Redirect Rule', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Modifies the redirect configuration of a site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -89388,130 +50306,83 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257658', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID. It can be obtained by calling the [ListRedirectRules](~~2867474~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '3528160969****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID. You can call the [ListRedirectRules](~~2867474~~) operation to obtain the configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '3528160969****', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. This parameter is not required when you add a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', + 'description' => 'Specifies whether to enable the rule. This parameter is not required when you add a global configuration. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], + 'schema' => ['description' => 'The rule content. A conditional expression is used to match user requests. This parameter is not required when you add a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + .'- Match specified requests: Set the value to a custom expression, such as (http.host eq \\"video.example.com\\").', 'type' => 'string', 'required' => false, 'example' => '(http.host eq "video.example.com")', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => 'Redirect type. Value range:'."\n" + 'description' => 'The redirect type. Valid values:'."\n" ."\n" - .'- static: Static mode.'."\n" - .'- dynamic: Dynamic mode.', + .'- static: static pattern.'."\n" + .'- dynamic: dynamic pattern.', + 'enumValueTitles' => ['static' => 'Static mode.', 'dynamic' => 'Dynamic pattern.'], 'type' => 'string', + 'enum' => ['static', 'dynamic'], 'required' => false, - 'enumValueTitles' => [ - 'static' => 'static', - 'dynamic' => 'dynamic', - ], 'example' => 'static', - 'enum' => [ - 'static', - 'dynamic', - ], 'title' => '', ], ], [ 'name' => 'TargetUrl', 'in' => 'query', - 'schema' => [ - 'description' => 'The target URL after redirection.', - 'type' => 'string', - 'required' => false, - 'example' => 'http://www.exapmle.com/index.html'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The target URL after the redirect.', 'type' => 'string', 'required' => false, 'example' => 'http://www.exapmle.com/index.html'."\n", 'title' => ''], ], [ 'name' => 'StatusCode', 'in' => 'query', 'schema' => [ - 'description' => 'The response status code used by the node to respond with the redirect address to the client. Value range:'."\n" + 'description' => 'The HTTP status code used when the node responds to the client with the redirect address. Valid values:'."\n" ."\n" .'- 301'."\n" .'- 302'."\n" .'- 303'."\n" .'- 307'."\n" .'- 308', + 'enumValueTitles' => [], 'type' => 'string', + 'enum' => ['301', '302', '303', '307', '308'], 'required' => false, 'example' => '301', - 'enum' => [ - '301', - '302', - '303', - '307', - '308', - ], 'title' => '', ], ], @@ -89519,45 +50390,31 @@ 'name' => 'ReserveQueryString', 'in' => 'query', 'schema' => [ - 'description' => 'Preserve query string. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', + 'description' => 'Specifies whether to preserve the query string. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'The execution order of the rule. Rules with smaller values take higher priority.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The execution order of the rule. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Request response result.', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'."\n", - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CB1A380B-09F0-41BB-A198-72F8FD6DA2FE'."\n"], ], 'example' => '', ], @@ -89565,191 +50422,72 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'VerifyExpressionError', - 'errorMessage' => 'Dynamic expression is invalid.', - 'description' => 'Dynamic expression is invalid.', - ], - [ - '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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => '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.'], + ['errorCode' => 'VerifyExpressionError', 'errorMessage' => 'Dynamic expression is invalid.', 'description' => 'Dynamic expression is invalid.'], + ['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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'Update Redirect Configuration', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\\\n\\"\\n}","type":"json"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'Update redirect configuration', 'changeSet' => [ - [ - 'createdAt' => '2025-04-10T07:02:38.000Z', - 'description' => 'Error codes changed, Request parameters changed', - ], - [ - 'createdAt' => '2025-03-27T02:58:48.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-04-10T07:02:38.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2025-03-27T02:58:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateRedirectRule', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRedirectRule'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateRedirectRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\\\\n\\"\\n}","type":"json"}]', ], 'UpdateRewriteUrlRule' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Modifies the URL rewrite configuration of a site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -89762,159 +50500,101 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257642', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'Configuration ID. It can be obtained by calling the [ListRewriteUrlRules](~~2867480~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '3528160969****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID. You can call the [ListRewriteUrlRules](~~2867480~~) operation to obtain the configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '3528160969****', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. This parameter is not required when adding a global configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'example=123'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. This parameter is not required when you add a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'example=123'."\n", 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Rule switch. This parameter is not required when adding a global configuration. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', + 'description' => 'The rule switch. This parameter is not required when you add a global configuration. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")', - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], + 'schema' => ['description' => 'The rule content. A conditional expression is used to match user requests. This parameter is not required when you add a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: Set the value to true.'."\n" + .'- Match specified requests: Set the value to a custom expression, for example, (http.host eq \\"video.example.com\\").', 'type' => 'string', 'required' => false, 'example' => '(http.host eq "video.example.com")', 'title' => ''], ], [ 'name' => 'RewriteUriType', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ - 'description' => 'URI rewrite type. Value range:'."\n" - .'- static: Static mode.'."\n" - .'- dynamic: Dynamic mode.', + 'description' => 'The path rewrite type. Valid values:'."\n" + .'- static: static pattern.'."\n" + .'- dynamic: dynamic pattern.', + 'enumValueTitles' => ['static' => 'Static mode.', 'dynamic' => 'Dynamic pattern.'], 'type' => 'string', + 'enum' => [], 'required' => false, - 'enumValueTitles' => [ - 'static' => 'static', - ], 'example' => 'static', - 'enum' => [], 'title' => '', ], ], [ 'name' => 'Uri', 'in' => 'query', - 'schema' => [ - 'description' => 'The target URI after rewriting.', - 'type' => 'string', - 'required' => false, - 'example' => '/image/example.jpg'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The target URI after rewriting.', 'type' => 'string', 'required' => false, 'example' => '/image/example.jpg'."\n", 'title' => ''], ], [ 'name' => 'RewriteQueryStringType', 'in' => 'query', 'schema' => [ - 'description' => 'Query string rewrite type. Value range:'."\n" - .'- static: Static mode.'."\n" - .'- dynamic: Dynamic mode.', + 'description' => 'The query character string rewrite type. Valid values:'."\n" + .'- static: static pattern.'."\n" + .'- dynamic: dynamic pattern.', + 'enumValueTitles' => ['static' => 'Static mode.', 'dynamic' => 'Dynamic pattern.'], 'type' => 'string', + 'enum' => [], 'required' => false, - 'enumValueTitles' => [ - 'static' => 'static', - ], 'example' => 'static', - 'enum' => [], 'title' => '', ], ], [ 'name' => 'QueryString', 'in' => 'query', - 'schema' => [ - 'description' => 'The query string after rewriting.', - 'type' => 'string', - 'required' => false, - 'example' => 'example=123'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The query string after rewriting.', 'type' => 'string', 'required' => false, 'example' => 'example=123'."\n", 'title' => ''], ], [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule execution order. A smaller numeric value indicates higher priority.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Request response result.', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '156A6B-677B1A-4297B7-9187B7-2B44792'], ], 'example' => '', ], @@ -89922,195 +50602,72 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'VerifyExpressionError', - 'errorMessage' => 'Dynamic expression is invalid.', - 'description' => 'Dynamic expression is invalid.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => '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.'], + ['errorCode' => 'VerifyExpressionError', 'errorMessage' => 'Dynamic expression is invalid.', 'description' => 'Dynamic expression is invalid.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'Modify Rewrite URL Configuration', - 'summary' => 'Modify Rewrite URL Rule', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"156A6B-677B1A-4297B7-9187B7-2B44792\\"\\n}","type":"json"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'Modify URL rewrite configuration', 'changeSet' => [ - [ - 'createdAt' => '2025-04-10T07:02:38.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2025-03-27T02:58:48.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-04-10T07:02:38.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2025-03-27T02:58:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateRewriteUrlRule', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRewriteUrlRule'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateRewriteUrlRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"156A6B-677B1A-4297B7-9187B7-2B44792\\"\\n}","type":"json"}]', ], 'UpdateRoutineConfigDescription' => [ 'summary' => 'Modifies the description of a routine.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -90122,32 +50679,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239144', - 'abilityTreeNodes' => [ - 'FEATUREdcdn75UYDO', - ], + 'abilityTreeNodes' => ['FEATUREdcdn75UYDO'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The routine name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-routine1', - 'title' => '', - ], + 'schema' => ['description' => 'The routine name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test-routine1', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'formData', - 'schema' => [ - 'description' => 'The routine description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'description of this routine', - 'title' => '', - ], + 'schema' => ['description' => 'The routine description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'description of this routine', 'title' => ''], ], ], 'responses' => [ @@ -90157,18 +50700,8 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395', - ], - 'Status' => [ - 'description' => 'Indicates whether the operation is successful.'."\n", - 'type' => 'string', - 'example' => 'OK', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395'], + 'Status' => ['description' => 'Indicates whether the operation is successful.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'example' => '', ], @@ -90176,36 +50709,14 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'RoutineNotExist', - 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', - 'description' => 'The routine name does not exist. Check the routine name and try again.', - ], - [ - 'errorCode' => 'InternalOperationError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'RoutineUserServiceStatusHalt', - 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', - 'description' => 'Failed to update the configurations because you have overdue payments.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'RoutineNotExist', 'errorMessage' => 'The routine name does not exist. Check the routine name and try again.', 'description' => 'The routine name does not exist. Check the routine name and try again.'], + ['errorCode' => 'InternalOperationError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'RoutineUserServiceStatusHalt', 'errorMessage' => 'Failed to update the configurations because you have overdue payments.', 'description' => 'Failed to update the configurations because you have overdue payments.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395\\",\\n \\"Status\\": \\"OK\\"\\n}","type":"json"}]', 'title' => 'UpdateRoutineConfigDescription', 'changeSet' => [], @@ -90220,12 +50731,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -90233,13 +50739,9 @@ 'operationType' => 'write', ], 'UpdateRoutineRoute' => [ - 'summary' => 'Modifies the route configuration of an edge function.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Modifies the route configuration of an Edge Routine.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -90252,96 +50754,52 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '266196', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456******', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456******', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the configuration.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '35281609698****', 'title' => ''], ], [ 'name' => 'RouteName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the route.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_route', - 'title' => '', - ], + 'schema' => ['description' => 'The route name.', 'type' => 'string', 'required' => false, 'example' => 'test_route', 'title' => ''], ], [ 'name' => 'RouteEnable', 'in' => 'query', - 'schema' => [ - 'description' => 'The routing switch. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'The route switch. Valid values:'."\n" + .'- on: enabled'."\n" + .'- off: disabled', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq \\"video.example.com\\")'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The rule content.', 'type' => 'string', 'required' => false, 'example' => '(http.host eq \\"video.example.com\\")'."\n", 'title' => ''], ], [ 'name' => 'RoutineName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the function.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-routine1', - 'title' => '', - ], + 'schema' => ['description' => 'The Edge Routine name.', 'type' => 'string', 'required' => false, 'example' => 'test-routine1', 'title' => ''], ], [ 'name' => 'Bypass', 'in' => 'query', 'schema' => [ - 'description' => 'Bypass mode. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", + 'description' => 'The bypass mode. Valid values:'."\n" + .'- on: enabled'."\n" + .'- off: disabled', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, - 'enum' => [ - 'on', - 'off', - ], 'example' => 'on', 'title' => '', ], @@ -90349,47 +50807,37 @@ [ 'name' => 'Sequence', 'in' => 'query', + 'schema' => ['description' => 'The rule execution order.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Fallback', + 'in' => 'query', 'schema' => [ - 'description' => 'The order in which the rule is executed.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The back-to-origin on exception switch. When enabled, if the function encounters an exception such as CPU usage exceeding the limit, the request is forwarded to the origin server. Valid values:'."\n" + .'- on: Enabled.'."\n" + .'- off: Disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], + 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, - 'example' => '1', + 'example' => 'on', 'title' => '', ], ], [ - 'name' => 'Fallback', + 'name' => 'Timeout', 'in' => 'query', - 'schema' => [ - 'description' => 'The exception origin switch. After you turn on this switch, if a function exception occurs, such as CPU usage exceeding the upper limit, requests are sent to the origin. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'required' => false, - 'enum' => [ - 'on', - 'off', - ], - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['title' => '', 'description' => 'The Edge Routine timeout period. Valid values: 5 to 60. Unit: seconds.', 'type' => 'string', 'example' => '5', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD'], ], 'example' => '', ], @@ -90397,155 +50845,47 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.', - ], - [ - 'errorCode' => 'InvalidRoutine', - 'errorMessage' => 'The name of routine is invalid.', - 'description' => 'Edge function name is illegal.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.'], + ['errorCode' => 'InvalidRoutine', 'errorMessage' => 'The name of routine is invalid.', 'description' => 'Edge function name is illegal.'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'UpdateRoutineRoute', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34DCBC8A-****-****-****-6DAA11D7DDBD\\"\\n}","type":"json"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'Modify edge routine route configuration', 'changeSet' => [ - [ - 'createdAt' => '2025-06-25T05:35:34.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-06-25T05:35:34.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '20', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateRoutineRoute', - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRoutineRoute'], ], ], 'ramActions' => [ @@ -90556,26 +50896,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34DCBC8A-****-****-****-6DAA11D7DDBD\\"\\n}","type":"json"}]', ], 'UpdateScheduledPreloadExecution' => [ - 'summary' => 'Updates a scheduled prefetch plan based on the plan ID.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Updates a scheduled prefetch plan by prefetch plan ID.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -90588,138 +50918,56 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239314', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4TTNAL', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4TTNAL'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the prefetch plan.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '66599bd7397885b43804901c', - 'title' => '', - ], + 'schema' => ['description' => 'The prefetch plan ID.', 'type' => 'string', 'required' => true, 'example' => '66599bd7397885b43804901c', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'formData', - 'schema' => [ - 'description' => 'The start time of the prefetch plan.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2024-05-31T17:10:48.849+08:00', - 'title' => '', - ], + 'schema' => ['description' => 'The start time of the scheduled prefetch plan, in ISO 8601 format (such as 2024-01-01T00:00:00+Z).', 'type' => 'string', 'required' => false, 'example' => '2024-05-31T17:10:48.849+08:00', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'formData', - 'schema' => [ - 'description' => 'The end time of the prefetch plan.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2024-05-31T18:10:48.849+08:00', - 'title' => '', - ], + 'schema' => ['description' => 'The end time of the scheduled prefetch plan, in ISO 8601 format (such as 2024-01-01T00:00:00+Z).', 'type' => 'string', 'required' => false, 'example' => '2024-05-31T18:10:48.849+08:00', 'title' => ''], ], [ 'name' => 'Interval', 'in' => 'formData', - 'schema' => [ - 'description' => 'The time interval between each batch execution. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - 'title' => '', - ], + 'schema' => ['description' => 'The execution interval between each batch of the scheduled prefetch plan, in seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''], ], [ 'name' => 'SliceLen', 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of URLs prefetched in each batch.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'title' => '', - ], + 'schema' => ['description' => 'The number of URLs to prefetch per batch.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A123425345', - ], - 'Id' => [ - 'description' => 'The ID of the prefetch plan.'."\n", - 'type' => 'string', - 'example' => '66599bd7397885b43804901c', - 'title' => '', - ], - 'StartTime' => [ - 'description' => 'The start time of the prefetch plan.'."\n", - 'type' => 'string', - 'example' => '2024-05-31T17:10:48.849+08:00', - 'title' => '', - ], - 'EndTime' => [ - 'description' => 'The end time of the prefetch plan.'."\n", - 'type' => 'string', - 'example' => '2024-05-31T18:10:48.849+08:00', - 'title' => '', - ], - 'Interval' => [ - 'description' => 'The time interval between each batch execution. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - 'title' => '', - ], - 'SliceLen' => [ - 'description' => 'The number of URLs prefetched in each batch.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the prefetch plan. Valid values:'."\n" - ."\n" - .'* **waiting**'."\n" - .'* **running**'."\n" - .'* **finished**'."\n" - .'* **failed**'."\n" - .'* **stopped**', - 'type' => 'string', - 'example' => 'running', - 'title' => '', - ], - 'JobId' => [ - 'description' => 'The ID of the prefetch task.'."\n", - 'type' => 'string', - 'example' => '665d3af3621bccf3fe29e1a4', - 'title' => '', - ], - 'AliUid' => [ - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => '15685865xxx14622', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A123425345'], + 'Id' => ['description' => 'The prefetch plan ID.', 'type' => 'string', 'example' => '66599bd7397885b43804901c', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the scheduled prefetch plan, in ISO 8601 format (such as 2024-01-01T00:00:00+Z).', 'type' => 'string', 'example' => '2024-05-31T17:10:48.849+08:00', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the scheduled prefetch plan, in ISO 8601 format (such as 2024-01-01T00:00:00+Z).', 'type' => 'string', 'example' => '2024-05-31T18:10:48.849+08:00', 'title' => ''], + 'Interval' => ['description' => 'The execution interval between each batch of the scheduled prefetch plan, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'SliceLen' => ['description' => 'The number of URLs to prefetch per batch.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Status' => ['description' => 'The status of the scheduled prefetch plan. Valid values:'."\n" + .'- **waiting**: Waiting to be executed.'."\n" + .'- **running**: Being executed.'."\n" + .'- **finished**: Execution completed.'."\n" + .'- **failed**: Execution failed.'."\n" + .'- **stopped**: Execution paused.', 'type' => 'string', 'example' => 'running', 'title' => ''], + 'JobId' => ['description' => 'The prefetch task ID.', 'type' => 'string', 'example' => '665d3af3621bccf3fe29e1a4', 'title' => ''], + 'AliUid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '15685865xxx14622', 'title' => ''], ], 'example' => '', ], @@ -90727,144 +50975,68 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], - [ - 'errorCode' => 'InvalidJob.JobCountOfSiteFull', - 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', - 'description' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', - ], - [ - 'errorCode' => 'InvalidParameter.ObjectId', - 'errorMessage' => 'Invalid task ID or execution plan ID.', - 'description' => 'Invalid task ID or execution plan ID.', - ], - [ - 'errorCode' => 'MissingOssUrl', - 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', - 'description' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', - ], - [ - 'errorCode' => 'MissingUrlList', - 'errorMessage' => 'Enter the URLs you want to prefetch.', - 'description' => 'Enter the URLs you want to prefetch.', - ], - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests.Please try again later.', - 'description' => 'Requests are too frequent, please try again later.', - ], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['errorCode' => 'InvalidJob.JobCountOfSiteFull', 'errorMessage' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', 'description' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.'], + ['errorCode' => 'InvalidParameter.ObjectId', 'errorMessage' => 'Invalid task ID or execution plan ID.', 'description' => 'Invalid task ID or execution plan ID.'], + ['errorCode' => 'MissingOssUrl', 'errorMessage' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', 'description' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.'], + ['errorCode' => 'MissingUrlList', 'errorMessage' => 'Enter the URLs you want to prefetch.', 'description' => 'Enter the URLs you want to prefetch.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], ], 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' => '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.', - ], + ['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' => '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.'], ], [ - [ - 'errorCode' => 'InvalidJob.NotFound', - 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', - 'description' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', - ], - [ - 'errorCode' => 'LogNotFound', - 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', - 'description' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', - ], - [ - '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' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.', - ], + ['errorCode' => 'InvalidJob.NotFound', 'errorMessage' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', 'description' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.'], + ['errorCode' => 'LogNotFound', 'errorMessage' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', 'description' => 'Failed to query the log. Check whether the task ID and execution ID are valid.'], + ['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' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.'], ], ], '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"}]', - 'title' => 'UpdateScheduledPreloadExecution', + 'title' => 'Update a scheduled prefetch plan', '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateScheduledPreloadExecution'], ], ], + 'ramActions' => [], ], 'UpdateSeoBypass' => [ - 'summary' => 'Modifies the search engine crawler configuration for a website.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Modifies the search engine crawler allowlisting configuration for a site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257452', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'Enable', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable the feature. Valid values:'."\n" + 'description' => 'The switch. Valid values:'."\n" ."\n" - .'* **on:**'."\n" - .'* **off**'."\n", + .'- **on**: enabled.'."\n" + .'- **off**: disabled.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, - 'enum' => [ - 'on', - 'off', - ], + 'enum' => ['on', 'off'], 'example' => 'on', 'title' => '', ], @@ -90873,16 +51045,11 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.'."\n", - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'], ], 'example' => '', ], @@ -90890,159 +51057,44 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => '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.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.', - ], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => '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.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', - 'title' => 'UpdateSeoBypass', + 'title' => 'Modify search engine crawler allowlisting configuration for a site', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateSeoBypass', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSeoBypass'], ], ], 'ramActions' => [ @@ -91053,26 +51105,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'operationType' => 'write', ], 'UpdateSiteAccessType' => [ 'summary' => 'Converts the DNS setup option of a website.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -91084,36 +51126,21 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239615', - 'abilityTreeNodes' => [ - 'FEATUREdcdnMF1S4U', - ], + 'abilityTreeNodes' => ['FEATUREdcdnMF1S4U'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890', 'title' => ''], ], [ 'name' => 'AccessType', 'in' => 'query', - 'schema' => [ - 'description' => 'The new DNS setup of the website. Valid values:'."\n" - ."\n" - .'* **NS**'."\n" - .'* **CNAME**'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'NS', - 'title' => '', - ], + 'schema' => ['description' => 'The new DNS setup of the website. Valid values:'."\n" + ."\n" + .'* **NS**'."\n" + .'* **CNAME**'."\n", 'type' => 'string', 'required' => true, 'example' => 'NS', 'title' => ''], ], ], 'responses' => [ @@ -91123,12 +51150,7 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74'], ], 'example' => '', ], @@ -91136,31 +51158,13 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'Site.ServiceBusy', - 'errorMessage' => 'This website is being configured. Try again later.', - 'description' => 'This website is being configured. Try again later.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'VerifyNameServerFailed', - 'errorMessage' => 'The NS verification failed. Please configure the NS provided by ESA on the domain name management platform and try again.', - 'description' => 'The NS verification failed. Please configure the NS provided by ESA on the domain name management platform and try again.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Site.ServiceBusy', 'errorMessage' => 'This website is being configured. Try again later.', 'description' => 'This website is being configured. Try again later.'], + ['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' => '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.'], + ['errorCode' => 'VerifyNameServerFailed', 'errorMessage' => 'The NS verification failed. Please configure the NS provided by ESA on the domain name management platform and try again.', 'description' => 'The NS verification failed. Please configure the NS provided by ESA on the domain name management platform and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', 'title' => 'UpdateSiteAccessType', 'description' => 'When you change the DNS setup of a website from NS to CNAME, note the following prerequisites:'."\n" @@ -91168,23 +51172,12 @@ .'* The website only has proxied A/AAAA and CNAME records.'."\n" .'* The DNS passthrough mode and custom nameserver features are not enabled for the website.'."\n", 'changeSet' => [ - [ - 'createdAt' => '2024-11-05T03:27:37.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T06:13:39.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-11-05T03:27:37.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T06:13:39.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateSiteAccessType', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSiteAccessType'], ], ], 'ramActions' => [ @@ -91195,12 +51188,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -91212,13 +51200,9 @@ ], ], 'UpdateSiteCoverage' => [ - 'summary' => 'Modifies the service location for a single website. This updates the acceleration configuration of the website to adapt to changes in traffic distribution, and improve user experience in specific regions.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Modifies the acceleration region of a site. Updates the acceleration configuration of a site to adapt to traffic distribution changes or improve the access experience for users in specific regions.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -91231,40 +51215,29 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239596', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID. You can call the [ListSites](~~2850189~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to query the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'Coverage', 'in' => 'query', 'schema' => [ - 'description' => 'The desired service location. Valid values:'."\n" + 'description' => 'The target acceleration region to change to. Valid values:'."\n" + .'- **domestic**: the Chinese mainland only.'."\n" + .'- **global**: global.'."\n" + .'- **overseas**: global (excluding the Chinese mainland).'."\n" ."\n" - .'* **domestic**: the Chinese mainland'."\n" - .'* **global**: global'."\n" - .'* **overseas**: outside the Chinese mainland'."\n", + .'If the value is set to domestic or global, the site corresponding to SiteId must have a valid ICP filing..', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, - 'example' => 'global', - 'enum' => [ - 'domestic', - 'global', - 'overseas', - ], + 'enum' => ['domestic', 'global', 'overseas'], + 'example' => 'overseas', 'title' => '', ], ], @@ -91274,12 +51247,7 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '65C66B7B-671A-8297-9187-2R5477247B76', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '65C66B7B-671A-8297-9187-2R5477247B76', 'title' => ''], ], 'description' => '', 'title' => '', @@ -91289,92 +51257,57 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'Site.ServiceBusy', - 'errorMessage' => 'This website is being configured. Try again later.', - 'description' => 'This website is being configured. Try again later.', - ], - [ - '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' => 'The selected location is unavailable in your plan. Change the location to one that is covered by the plan and try again.', - ], - [ - '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' => 'The current site has an existing four-layer accelerated application, and the current operation is not allowed. If necessary, please contact customer service.', - ], - [ - 'errorCode' => 'IpaNotActive', - 'errorMessage' => 'The ipa application is not active.', - 'description' => 'The ipa application is not active.', - ], - [ - '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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Site.ServiceBusy', 'errorMessage' => 'This website is being configured. Try again later.', 'description' => 'This website is being configured. Try again later.'], + ['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' => 'The selected location is unavailable in your plan. Change the location to one that is covered by the plan and try again.'], + ['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' => 'The current site has an existing four-layer accelerated application, and the current operation is not allowed. If necessary, please contact customer service.'], + ['errorCode' => 'IpaNotActive', 'errorMessage' => 'The ipa application is not active.', 'description' => 'The ipa application is not active.'], + ['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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.'], + ['errorCode' => 'NotEnoughResource.CustomPort', 'errorMessage' => 'Resource verification failed because there are not enough IP resources.', 'description' => 'Resource verification failed because there are not enough IP resources.'], + ['errorCode' => 'Site.HasStaticIP', 'errorMessage' => 'This operation is not allowed because the site has static IP enabled.', 'description' => 'This operation is not allowed because the site has static IP enabled.'], + ['errorCode' => 'Site.HasCN2', 'errorMessage' => 'The website has enabled CN2, and this operation is not allowed.', 'description' => 'Network access optimization in mainland China is enabled for this site. This operation is not allowed.'], + ['errorCode' => 'Site.HasIpaEnableKeepAliveProtection', 'errorMessage' => 'The site has one or more TCP/UDP proxied applications with keep-alive-protection enabled. Its acceleration region or plan can\'t be edited.', 'description' => 'The site has one or more TCP/UDP proxied applications with keep-alive-protection enabled. Its acceleration region or plan can\'t be edited.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'title' => 'UpdateSiteCoverage', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65C66B7B-671A-8297-9187-2R5477247B76\\"\\n}","type":"json"}]', + 'title' => 'Modify site acceleration region', 'changeSet' => [ - [ - 'createdAt' => '2025-04-23T01:46:45.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-10-15T05:52:17.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-24T09:13:34.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T06:13:39.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-04-23T01:46:45.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-10-15T05:52:17.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-24T09:13:34.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T06:13:39.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateSiteCoverage', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSiteCoverage'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateSiteCoverage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65C66B7B-671A-8297-9187-2R5477247B76\\"\\n}","type":"json"}]', ], 'UpdateSiteCustomLog' => [ 'summary' => 'Modifies the configuration of custom request header, response header, and cookie fields that are used to capture logs of a website.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -91386,22 +51319,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238355', - 'abilityTreeNodes' => [ - 'FEATUREdcdn9K10I1', - ], + 'abilityTreeNodes' => ['FEATUREdcdn9K10I1'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'formData', - 'schema' => [ - 'description' => 'site id'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '11223****', - 'title' => '', - ], + 'schema' => ['description' => 'site id'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11223****', 'title' => ''], ], [ 'name' => 'RequestHeaders', @@ -91410,13 +51334,7 @@ 'schema' => [ 'description' => 'The request header fields.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The request header field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'x-acs-request-id', - 'title' => '', - ], + 'items' => ['description' => 'The request header field.'."\n", 'type' => 'string', 'required' => false, 'example' => 'x-acs-request-id', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', @@ -91429,13 +51347,7 @@ 'schema' => [ 'description' => 'The response header fields.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The response header field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'X_Swift_Error', - 'title' => '', - ], + 'items' => ['description' => 'The response header field.'."\n", 'type' => 'string', 'required' => false, 'example' => 'X_Swift_Error', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', @@ -91448,13 +51360,7 @@ 'schema' => [ 'description' => 'The cookie fields.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The cookie field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sessionId', - 'title' => '', - ], + 'items' => ['description' => 'The cookie field.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sessionId', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', @@ -91468,12 +51374,7 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ET5BF670-09D5-4D0B-BEBY-D96A2A528000', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ET5BF670-09D5-4D0B-BEBY-D96A2A528000'], ], 'example' => '', ], @@ -91481,44 +51382,22 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], ], 403 => [ - [ - 'errorCode' => 'RealTimeLog.NameCheckFail', - 'errorMessage' => 'Real-time log name field validity check failed.', - 'description' => 'The real-time log configuration field you entered contains illegal characters. Please delete the illegal characters and try again. The allowed characters include numbers, letters, underscore "_" and spaces "".', - ], + ['errorCode' => 'RealTimeLog.NameCheckFail', 'errorMessage' => 'Real-time log name field validity check failed.', 'description' => 'The real-time log configuration field you entered contains illegal characters. Please delete the illegal characters and try again. The allowed characters include numbers, letters, underscore "_" and spaces "".'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ET5BF670-09D5-4D0B-BEBY-D96A2A528000\\"\\n}","type":"json"}]', 'title' => 'UpdateSiteCustomLog', 'changeSet' => [ - [ - 'createdAt' => '2024-09-27T05:57:02.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-27T05:57:02.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateSiteCustomLog', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSiteCustomLog'], ], ], 'ramActions' => [ @@ -91529,12 +51408,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -91546,13 +51420,8 @@ ], ], 'UpdateSiteDeliveryTask' => [ - 'summary' => 'Modifies a real-time log delivery task.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -91565,99 +51434,57 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238989', - 'abilityTreeNodes' => [ - 'FEATUREdcdn9K10I1', - ], + 'abilityTreeNodes' => ['FEATUREdcdn9K10I1'], ], 'parameters' => [ [ 'name' => 'TaskName', 'in' => 'formData', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '', - 'description' => 'The name of the delivery task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cdn-test-task', - ], + 'schema' => ['description' => 'The task name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cdn-test-task'], ], [ 'name' => 'SiteId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can obtain this ID by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'FieldName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The log fields that you want to include in real-time logs to be delivered. Separate the log fields with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ClientIP,UserAgent', - 'title' => '', - ], + 'schema' => ['description' => 'A comma-separated list of delivery fields.', 'type' => 'string', 'required' => true, 'example' => 'ClientIP,UserAgent', 'title' => ''], ], [ 'name' => 'BusinessType', 'in' => 'formData', - 'schema' => [ - 'description' => 'The log category. Valid values:'."\n" - ."\n" - .'* dcdn_log_access_l1 (default): access logs.'."\n" - .'* dcdn_log_er: Edge Routine logs.'."\n" - .'* dcdn_log_waf: firewall logs.'."\n" - .'* dcdn_log_ipa: TCP/UDP proxy logs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dcdn_log_er', - 'title' => '', - ], + 'schema' => ['description' => 'The real-time log type. Valid values:'."\n" + ."\n" + .'- **dcdn\\_log\\_access\\_l1** (default): access log.'."\n" + ."\n" + .'- **dcdn\\_log\\_er**: Edge Routine log.'."\n" + ."\n" + .'- **dcdn\\_log\\_waf**: WAF log.'."\n" + ."\n" + .'- **dcdn\\_log\\_ipa**: Layer 4 acceleration log.', 'type' => 'string', 'required' => false, 'example' => 'dcdn_log_er', 'title' => ''], ], [ 'name' => 'DiscardRate', 'in' => 'formData', - 'schema' => [ - 'description' => 'The discard rate.'."\n", - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '0.0', - 'title' => '', - ], + 'schema' => ['description' => 'The discard rate.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.0', 'title' => ''], ], [ 'name' => 'FilterVer', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD'], ], 'example' => '', ], @@ -91665,56 +51492,28 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], ], 403 => [ - [ - 'errorCode' => 'EsaService.NotOpen', - 'errorMessage' => 'ESA service has not opend.', - 'description' => 'Edge Security Accelerator (ESA) is not turned on', - ], + ['errorCode' => 'EsaService.NotOpen', 'errorMessage' => 'ESA service has not opend.', 'description' => 'Edge Security Accelerator (ESA) is not turned on'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34DCBC8A-****-****-****-6DAA11D7DDBD\\"\\n}","type":"json"}]', 'title' => 'UpdateSiteDeliveryTask', + 'summary' => 'Updates a site delivery task.', 'changeSet' => [ - [ - 'createdAt' => '2025-06-24T01:43:11.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-10-18T01:07:11.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-27T05:57:02.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-06-24T01:43:11.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-10-18T01:07:11.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-27T05:57:02.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateSiteDeliveryTask', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSiteDeliveryTask'], ], ], 'ramActions' => [ @@ -91725,25 +51524,17 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => 'Changes the status of a real-time log delivery task.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -91755,45 +51546,24 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239089', - 'abilityTreeNodes' => [ - 'FEATUREdcdn9K10I1', - ], + 'abilityTreeNodes' => ['FEATUREdcdn9K10I1'], ], 'parameters' => [ [ 'name' => 'TaskName', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '', - 'description' => 'The name of the delivery task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cdn-test-task', - ], + 'schema' => ['title' => '', 'description' => 'The name of the delivery task.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cdn-test-task'], ], [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'Method', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the delivery task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'online', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable the delivery task.'."\n", 'type' => 'string', 'required' => true, 'example' => 'online', 'title' => ''], ], ], 'responses' => [ @@ -91803,27 +51573,12 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', - ], - 'TaskName' => [ - 'description' => 'The name of the delivery task.'."\n", - 'type' => 'string', - 'example' => 'cdn-test-task', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the delivery task. Valid values:'."\n" - ."\n" - .'* **online**'."\n" - .'* **offline**'."\n", - 'type' => 'string', - 'example' => 'online', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD'], + 'TaskName' => ['description' => 'The name of the delivery task.'."\n", 'type' => 'string', 'example' => 'cdn-test-task', 'title' => ''], + 'Status' => ['description' => 'The status of the delivery task. Valid values:'."\n" + ."\n" + .'* **online**'."\n" + .'* **offline**'."\n", 'type' => 'string', 'example' => 'online', 'title' => ''], ], 'example' => '', ], @@ -91831,37 +51586,19 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34DCBC8A-****-****-****-6DAA11D7DDBD\\",\\n \\"TaskName\\": \\"cdn-test-task\\",\\n \\"Status\\": \\"online\\"\\n}","type":"json"}]', 'title' => 'UpdateSiteDeliveryTaskStatus', 'changeSet' => [ - [ - 'createdAt' => '2024-09-27T05:57:02.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-27T05:57:02.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateSiteDeliveryTaskStatus', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSiteDeliveryTaskStatus'], ], ], 'ramActions' => [ @@ -91872,12 +51609,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -91889,56 +51621,42 @@ ], ], 'UpdateSiteNameExclusive' => [ - 'summary' => 'Modifies the site hold configuration of a website. After you enable site hold, other accounts cannot add your website domain or its subdomains to ESA.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Modifies the exclusive site name configuration. After this feature is enabled, other accounts can no longer create sites or subsites with the same name as the current site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257454', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'Enable', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable site hold. Valid values:'."\n" + 'description' => 'The feature switch. Valid values:'."\n" ."\n" - .'* on'."\n" - .'* off'."\n", + .'- on: enabled.'."\n" + .'- off: disabled.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, + 'enum' => ['on', 'off'], 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], @@ -91946,16 +51664,11 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9'], ], 'example' => '', ], @@ -91963,159 +51676,44 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => '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.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.', - ], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => '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.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', - 'title' => 'UpdateSiteNameExclusive', + 'title' => 'Modify exclusive site name configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateSiteNameExclusive', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSiteNameExclusive'], ], ], 'ramActions' => [ @@ -92126,26 +51724,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'operationType' => 'write', ], 'UpdateSitePause' => [ - 'summary' => 'Modifies the ESA proxy configuration of a website.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Modifies the site pause configuration.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -92158,37 +51746,26 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257464', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID. Check the Status field to confirm the site status and the AccessType field to confirm the access mode of the site.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****'."\n", 'title' => ''], ], [ 'name' => 'Paused', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to temporarily pause ESA on the website. If you set this parameter to true, all requests to the domains in your DNS records go directly to your origin server. Valid values:'."\n" + 'description' => 'Specifies whether to temporarily pause the proxy acceleration feature for the entire site. After the feature is paused, all DNS records directly return record values to the client. Valid values:'."\n" + .'- true: Pauses site acceleration.'."\n" + .'- false: Resumes normal site acceleration.'."\n" ."\n" - .'* true'."\n" - .'* false'."\n", + .'When site acceleration is paused, only activated sites with NS access mode are supported.', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'required' => true, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], 'example' => 'true', 'title' => '', ], @@ -92197,16 +51774,11 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6abd807e-ed2a-44de-ac54-ac38a62472e6', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '6abd807e-ed2a-44de-ac54-ac38a62472e6'], ], 'example' => '', ], @@ -92214,154 +51786,44 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => '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.', - ], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => '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.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'UpdateSitePause', - 'description' => '该API仅适用于NS方式接入的站点。', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6abd807e-ed2a-44de-ac54-ac38a62472e6\\"\\n}","type":"json"}]', + 'title' => 'Modify site pause configuration', + 'description' => 'This API operation can be called only for sites that use the NS access mode.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateSitePause', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSitePause'], ], ], 'ramActions' => [ @@ -92372,80 +51834,50 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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"}]', - 'translator' => 'machine', ], 'UpdateSiteVanityNS' => [ - 'summary' => 'Updates the custom nameserver names for a single website.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Modifies the custom nameserver (NS) names for a single site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239620', - 'abilityTreeNodes' => [ - 'FEATUREdcdnMF1S4U', - ], + 'abilityTreeNodes' => ['FEATUREdcdnMF1S4U'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID. You can call the [ListSites](~~2850189~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to query the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'VanityNSList', 'in' => 'query', - 'schema' => [ - 'description' => 'The custom nameserver names. You can specify two to five custom nameserver names. Separate multiple names with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ns1.example.com,ns2.example.com', - 'title' => '', - ], + 'schema' => ['description' => 'The list of custom NS names. You can specify 2 to 5 custom NS names, separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => 'ns1.example.com,ns2.example.com', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9'], ], 'example' => '', ], @@ -92453,91 +51885,35 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'ApplyVanityNSError', - 'errorMessage' => 'Failed to apply for vanity NS resources. Please contact customer service.', - 'description' => 'Failed to apply for vanity NS resources. Please contact customer service.', - ], - [ - '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' => 'Sites that are accessed only by NS mode can use custom NS. Please adjust your site access mode and try again.', - ], - [ - 'errorCode' => 'InvalidParameter.InvalidVanityNSNum', - 'errorMessage' => 'Enter 2 to 5 vanity nameservers. Correct them and try again.', - 'description' => 'Custom NS requires 2~5 names, please adjust and resubmit.', - ], - [ - 'errorCode' => 'InvalidParameter.InvalidVanityNSName', - 'errorMessage' => 'A vanity nameserver must be an absolute domain name. Correct it and try again.', - 'description' => 'You need to enter the full domain name to customize the NS name. Please adjust and submit it again.', - ], - [ - 'errorCode' => 'InvalidParameter.VanityNSNameDuplicate', - 'errorMessage' => 'The vanity nameservers are duplicated. Please delete it and try again.', - 'description' => 'Duplicate custom NS name exists, please delete and resubmit.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.CustomNS', - 'errorMessage' => 'Custom nameservers are not allowed in your plan. Check the plan description and upgrade the plan.', - 'description' => 'Custom nameservers are not allowed in your plan. Check the plan description and upgrade the plan.', - ], - [ - 'errorCode' => 'Site.ServiceBusy', - 'errorMessage' => 'This website is being configured. Try again later.', - 'description' => 'This website is being configured. Try again later.', - ], - [ - 'errorCode' => 'Record.Conflict', - 'errorMessage' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', - 'description' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.RecordsExceedLimit', - 'errorMessage' => 'The number of incoming records exceeds the maximum limit.', - 'description' => 'The number of incoming records exceeds the maximum limit.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'ApplyVanityNSError', 'errorMessage' => 'Failed to apply for vanity NS resources. Please contact customer service.', 'description' => 'Failed to apply for vanity NS resources. Please contact customer service.'], + ['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' => 'Sites that are accessed only by NS mode can use custom NS. Please adjust your site access mode and try again.'], + ['errorCode' => 'InvalidParameter.InvalidVanityNSNum', 'errorMessage' => 'Enter 2 to 5 vanity nameservers. Correct them and try again.', 'description' => 'Custom NS requires 2~5 names, please adjust and resubmit.'], + ['errorCode' => 'InvalidParameter.InvalidVanityNSName', 'errorMessage' => 'A vanity nameserver must be an absolute domain name. Correct it and try again.', 'description' => 'You need to enter the full domain name to customize the NS name. Please adjust and submit it again.'], + ['errorCode' => 'InvalidParameter.VanityNSNameDuplicate', 'errorMessage' => 'The vanity nameservers are duplicated. Please delete it and try again.', 'description' => 'Duplicate custom NS name exists, please delete and resubmit.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'QuotaCheckFailed.CustomNS', 'errorMessage' => 'Custom nameservers are not allowed in your plan. Check the plan description and upgrade the plan.', 'description' => 'Custom nameservers are not allowed in your plan. Check the plan description and upgrade the plan.'], + ['errorCode' => 'Site.ServiceBusy', 'errorMessage' => 'This website is being configured. Try again later.', 'description' => 'This website is being configured. Try again later.'], + ['errorCode' => 'Record.Conflict', 'errorMessage' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', 'description' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.'], + ['errorCode' => 'InvalidParameter.RecordsExceedLimit', 'errorMessage' => 'The number of incoming records exceeds the maximum limit.', 'description' => 'The number of incoming records exceeds the maximum limit.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\"\\n}","type":"json"}]', - 'title' => 'UpdateSiteVanityNS', + 'title' => 'Modify custom NS servers for a site', + 'description' => 'The site plan must be Enterprise Edition or higher to use the custom NS feature.', 'changeSet' => [ - [ - 'createdAt' => '2024-11-05T03:27:36.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T06:13:39.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-11-05T03:27:36.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T06:13:39.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateSiteVanityNS', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSiteVanityNS'], ], ], 'ramActions' => [ @@ -92548,29 +51924,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], - 'operationType' => 'write', - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], ], 'UpdateTieredCache' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Modifies the multi-level cache configuration of a site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -92583,42 +51946,28 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257320', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call [ListSites](~~2850189~~) to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'CacheArchitectureMode', 'in' => 'query', 'schema' => [ - 'description' => 'The tiered cache architecture mode. Valid values:'."\n" - ."\n" - .'* edge: edge tiered cache.'."\n" - .'* edge_smart: edge tiered cache + smart tiered cache.'."\n" - .'* edge_regional: edge tiered cache + regional tiered cache.'."\n" - .'* edge_regional_smart: edge tiered cache + regional tiered cache + smart tiered cache.'."\n", + 'description' => 'The multi-level cache architecture mode. Valid values:'."\n" + .'- edge: edge cache layer.'."\n" + .'- edge_smart: edge cache layer + smart cache layer.'."\n" + .'- edge_regional: edge cache layer + regional cache layer.'."\n" + .'- edge_regional_smart: edge cache layer + regional cache layer + smart cache layer.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, + 'enum' => ['edge', 'edge_smart', 'edge_regional', 'edge_regional_smart'], 'example' => 'edge_smart', - 'enum' => [ - 'edge', - 'edge_smart', - 'edge_regional', - 'edge_regional_smart', - ], 'title' => '', ], ], @@ -92626,16 +51975,11 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '15C66C7B-671A-4297-9187-2C4477247A74', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '15C66C7B-671A-4297-9187-2C4477247A74'], ], 'example' => '', ], @@ -92643,121 +51987,54 @@ ], '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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'FunctionArgError', - 'errorMessage' => 'Failed to check the configured function parameters.', - 'description' => 'Failed to check the configured function parameters', - ], + ['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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'FunctionArgError', 'errorMessage' => 'Failed to check the configured function parameters.', 'description' => 'Failed to check the configured function parameters'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'UpdateTieredCache', - 'summary' => 'Modifies the tiered cache configuration of your website.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', + 'title' => 'Modify site multi-level cache configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateTieredCache', + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTieredCache'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:UpdateTieredCache', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], + ], ], ], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15C66C7B-671A-4297-9187-2C4477247A74\\"\\n}","type":"json"}]', ], 'UpdateTransportLayerApplication' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Modifies the forwarding rule configurations of a Layer 4 application under a specified site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -92770,132 +52047,82 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '245118', - 'abilityTreeNodes' => [ - 'FEATUREdcdnVFT29S', - ], + 'abilityTreeNodes' => ['FEATUREdcdnVFT29S'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ApplicationId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'Transport layer application ID, which can be obtained by calling the [ListTransportLayerApplications](~~ListTransportLayerApplications~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '165503967****', - 'title' => '', - ], + 'schema' => ['description' => 'The Layer 4 application ID. You can call the [ListTransportLayerApplications](~~ListTransportLayerApplications~~) operation to obtain the application ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '165503967****', 'title' => ''], ], [ 'name' => 'Rules', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'Forwarding rule list. Details of each rule. Except for the comment, all other parameters are required.', + 'description' => 'The list of forwarding rules. For each rule, all parameters except the comment are required.', 'type' => 'array', 'items' => [ - 'description' => 'Details of each rule. Except for the comment, all other parameters are required.', + 'description' => 'The rule details. For each rule, all parameters except the comment are required.', 'type' => 'object', 'properties' => [ 'Protocol' => [ - 'description' => 'Forwarding rule protocol, supports:'."\n" + 'description' => 'The forwarding rule protocol. Valid values:'."\n" ."\n" .'- TCP: TCP protocol.'."\n" .'- UDP: UDP protocol.', + 'enumValueTitles' => ['TCP' => 'TCP 协议', 'UDP' => 'UDP 协议'], 'type' => 'string', + 'enum' => ['TCP', 'UDP'], 'required' => false, - 'enum' => [ - 'TCP', - 'UDP', - ], 'example' => 'TCP', 'title' => '', ], - 'EdgePort' => [ - 'description' => 'Edge port. Supports:'."\n" - ."\n" - .'- A single port, e.g., 80.'."\n" - .'- Port range, e.g., 81-85, representing ports 81, 82, 83, 84, 85.'."\n" - .'- Combination of ports and port ranges, separated by commas, e.g., 80,81-85,90, representing ports 80, 81, 82, 83, 84, 85, 90.'."\n" - .'- Edge ports within a single rule and between multiple rules must not overlap.', - 'type' => 'string', - 'required' => false, - 'example' => '80', - 'title' => '', - ], + 'EdgePort' => ['description' => 'The edge port. Valid values:'."\n" + ."\n" + .'- A single port, such as 80.'."\n" + .'- A port range, such as 81-85, which represents ports 81, 82, 83, 84, and 85.'."\n" + .'- A combination of ports and port ranges separated by commas, such as 80,81-85,90, which represents ports 80, 81, 82, 83, 84, 85, and 90.'."\n" + .'- Edge ports within a single rule and across multiple rules cannot overlap.', 'type' => 'string', 'required' => false, 'example' => '80', 'title' => ''], 'SourceType' => [ - 'description' => 'Source type, supports:'."\n" + 'description' => 'The origin type. Valid values:'."\n" .'- **ip**: IP address.'."\n" - .'- **domain**: Domain name.'."\n" - .'- **OP**: Origin pool.'."\n" - .'- **LB**: Load balancer.', + .'- **domain**: domain name.'."\n" + .'- **OP**: origin IPAM pool.'."\n" + .'- **LB**: load balancing.', + 'enumValueTitles' => ['OP' => '源地址池', 'LB' => '负载均衡器', 'ip' => 'IP', 'domain' => '域名'], 'type' => 'string', + 'enum' => ['ip', 'domain', 'LB', 'OP'], 'required' => false, - 'enum' => [ - 'ip', - 'domain', - 'LB', - 'OP', - ], 'example' => 'ip', 'title' => '', ], - 'SourcePort' => [ - 'description' => 'Source port. Supports:'."\n" - ."\n" - .'- A single port, when the source port is a single port, any valid edge port combination is supported.'."\n" - .'- Port range, only when the edge port is a port range, the source port can be set as a port range, and the size of the range must match that of the edge port. For example, if the edge port is 90-93, the source port cannot be set to 81-85 because the source port range is 5 and the edge port range is 3, which do not match.', - 'type' => 'string', - 'required' => false, - 'example' => '80', - 'title' => '', - ], + 'SourcePort' => ['description' => 'Origin Server Port. Valid values:'."\n" + ."\n" + .'- A single port. When Origin Server Port is a single port, any valid edge port combination is supported.'."\n" + .'- A port range. Origin Server Port can be set to a port range only when the edge port is a port range, and the range size must match the edge port range. For example, if the edge port is 90-93, you cannot set Origin Server Port to 81-85 because Origin Server Port range is 5 while the edge port range is 4, which are inconsistent.', 'type' => 'string', 'required' => false, 'example' => '80', 'title' => ''], 'ClientIPPassThroughMode' => [ - 'description' => 'Client IP pass-through protocol, supports:'."\n" - .'- **off**: No pass-through.'."\n" - .'- **PPv1**: PROXY Protocol v1, supports client IP pass-through for TCP protocol.'."\n" - .'- **PPv2**: PROXY Protocol v2, supports client IP pass-through for TCP and UDP protocols.'."\n" - .'- **SPP**: Simple Proxy Protocol, supports client IP pass-through for UDP protocol.', + 'description' => 'The client IP pass-through protocol. Valid values:'."\n" + .'- **off**: disabled.'."\n" + .'- **PPv1**: PROXY Protocol v1, which supports client IP pass-through for TCP.'."\n" + .'- **PPv2**: PROXY Protocol v2, which supports client IP pass-through for TCP and UDP.'."\n" + .'- **SPP**: Simple Proxy Protocol, which supports client IP pass-through for UDP.', + 'enumValueTitles' => ['SPP' => 'Simple Proxy Protocol 协议', 'PPv2' => 'PROXY Protocol v2 协议', 'off' => '不传递', 'PPv1' => 'PROXY Protocol v1 协议'], 'type' => 'string', + 'enum' => ['off', 'PPv1', 'PPv2', 'SPP'], 'required' => false, - 'enum' => [ - 'off', - 'PPv1', - 'PPv2', - 'SPP', - ], 'example' => 'SPP', 'title' => '', ], - 'Source' => [ - 'description' => 'Specific value of the source.', - 'type' => 'string', - 'required' => false, - 'example' => '1.1.1.1', - 'title' => '', - ], - 'Comment' => [ - 'description' => 'Comment information for the rule.', - 'type' => 'string', - 'required' => false, - 'example' => '123', - 'title' => '', - ], + 'Source' => ['description' => 'The specific value of the origin.', 'type' => 'string', 'required' => false, 'example' => '1.1.1.1', 'title' => ''], + 'Comment' => ['description' => 'The comment for the rule.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], 'required' => false, 'title' => '', @@ -92910,16 +52137,13 @@ 'name' => 'IpAccessRule', 'in' => 'query', 'schema' => [ - 'description' => 'IP access rule switch. When enabled, the IP access rules in WAF will take effect on the transport layer application.'."\n" + 'description' => 'The IP access rule switch. When enabled, WAF IP access rules take effect for the Layer 4 application. Valid values:'."\n" ."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', + .'- on: enabled.'."\n" + .'- off: disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], 'example' => 'on', 'title' => '', ], @@ -92928,13 +52152,13 @@ 'name' => 'Ipv6', 'in' => 'query', 'schema' => [ - 'description' => 'IPv6 switch.', + 'description' => 'The IPv6 switch. Valid values:'."\n" + ."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], 'example' => 'on', 'title' => '', ], @@ -92943,16 +52167,13 @@ 'name' => 'CrossBorderOptimization', 'in' => 'query', 'schema' => [ - 'description' => 'Whether to enable China mainland network access optimization, default is disabled. Value range:'."\n" + 'description' => 'Specifies whether to enable network access optimization for the Chinese mainland. This feature is disabled by default. Valid values:'."\n" ."\n" - .'- on: Enabled.'."\n" - .'- off: Disabled.', + .'- on: enabled.'."\n" + .'- off: disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], 'example' => 'on', 'title' => '', ], @@ -92960,27 +52181,35 @@ [ 'name' => 'StaticIp', 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable static IP. This feature is disabled by default. Valid values:'."\n" + ."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'required' => false, 'example' => 'off', 'title' => ''], + ], + [ + 'name' => 'KeepAliveProtection', + 'in' => 'query', 'schema' => [ + 'title' => '', + 'description' => 'Specifies whether to enable keep-alive protection. This feature is disabled by default. Valid values:'."\n" + ."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, - 'description' => '', - 'title' => '', - 'example' => '', + 'example' => 'off', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Response for a successful request.', + 'description' => 'The response for a successful request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '9e5448c7-edaf-49aa-9887-0fcd0832306c', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9e5448c7-edaf-49aa-9887-0fcd0832306c', 'title' => ''], ], 'title' => '', 'example' => '', @@ -92989,131 +52218,44 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter.RecordData', - 'errorMessage' => 'Invalid record content. Adjust your configurations based on the API documentation.', - 'description' => 'Invalid record content. Adjust your configurations based on the API documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.RecordType', - 'errorMessage' => 'Invalid record type. Adjust your configurations based on the API documentation.', - 'description' => 'Invalid record type. Adjust your configurations based on the API documentation.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'QuotaExceed.RecordCount', - 'errorMessage' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.', - 'description' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.', - ], - [ - 'errorCode' => 'Record.Conflict', - 'errorMessage' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', - 'description' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', - ], - [ - 'errorCode' => 'Site.ServiceBusy', - 'errorMessage' => 'This website is being configured. Try again later.', - 'description' => 'This website is being configured. Try again later.', - ], - [ - 'errorCode' => 'TransportLayerApplicationNotExist', - 'errorMessage' => 'The layer -4 accelerated application of the current operation does not exist. Modify it and try again.', - 'description' => 'The layer -4 accelerated application of the current operation does not exist. Modify it and try again.', - ], - [ - 'errorCode' => 'TransportLayerRulesExceedLimit', - 'errorMessage' => 'The configured forwarding rules have exceeded the maximum limit. Delete useless forwarding rules and try again.', - 'description' => 'The configured forwarding rules have exceeded the maximum limit. Delete useless forwarding rules and try again.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'InvalidParameter.InvalidRecordName', - 'errorMessage' => 'The record name you entered does not meet the specifications. Change the record name according to the product documentation.', - 'description' => 'The record name you entered does not meet the specifications. Please adjust the record name according to the product documentation.', - ], - [ - 'errorCode' => 'EdgePortsOverlap', - 'errorMessage' => 'There is overlap between multiple edge ports, please check and try again after modification.', - 'description' => 'There is overlap between multiple edge ports, please check and try again after modification.', - ], - [ - 'errorCode' => 'InvalidParameter.ClientIpPassThroughMode', - 'errorMessage' => 'Invalid client IP transfer protocol, please refer to the interface document and pass in valid parameters.', - 'description' => 'Invalid client IP transfer protocol, please refer to the interface document and pass in valid parameters.', - ], - [ - 'errorCode' => 'InvalidParameter.RuleSource', - 'errorMessage' => 'The origin of the forwarding rule does not exist or is invalid. Enter the correct origin and try again.', - 'description' => 'The origin of the forwarding rule does not exist or is invalid. Enter the correct origin and try again.', - ], - [ - 'errorCode' => 'InvalidParameter.Port', - 'errorMessage' => 'Invalid edge port or origin port. Enter a valid port as required in the interface document.', - 'description' => 'Invalid edge port or origin port. Enter a valid port as required in the interface document.', - ], - [ - 'errorCode' => 'InvalidParameter.Protocol', - 'errorMessage' => 'Invalid port protocol. Enter a valid port protocol as required by the interface documentation.', - 'description' => 'Invalid port protocol. Enter a valid port protocol as required by the interface documentation.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], - [ - 'errorCode' => 'IpaNotActive', - 'errorMessage' => 'The ipa application is not active.', - 'description' => 'The ipa application is not active.', - ], - [ - 'errorCode' => 'Record.NoResource', - 'errorMessage' => 'Failed to allocate resources for the record. Please submit a ticket for processing.', - 'description' => 'Failed to allocate resources for the record. Please submit a work order for processing.', - ], - [ - 'errorCode' => 'InvalidParameter.PrivateIpAsSourceUnsupported', - 'errorMessage' => 'The provided source is an invalid private IP address. Please verify and resubmit.', - 'description' => 'The provided source is an invalid private IP address. Please verify and resubmit.', - ], - [ - 'errorCode' => 'InvalidParameter.SourceIpInBlacklist', - 'errorMessage' => 'The provided source is an invalid private IP address. Please verify and resubmit.', - 'description' => 'The provided source is an invalid private IP address. Please verify and resubmit.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'Update Transport Layer Acceleration Application', - 'summary' => 'Modify Transport Layer Application', + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter.RecordData', 'errorMessage' => 'Invalid record content. Adjust your configurations based on the API documentation.', 'description' => 'Invalid record content. Adjust your configurations based on the API documentation.'], + ['errorCode' => 'InvalidParameter.RecordType', 'errorMessage' => 'Invalid record type. Adjust your configurations based on the API documentation.', 'description' => 'Invalid record type. Adjust your configurations based on the API documentation.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'QuotaExceed.RecordCount', 'errorMessage' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.', 'description' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.'], + ['errorCode' => 'Record.Conflict', 'errorMessage' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', 'description' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.'], + ['errorCode' => 'Site.ServiceBusy', 'errorMessage' => 'This website is being configured. Try again later.', 'description' => 'This website is being configured. Try again later.'], + ['errorCode' => 'TransportLayerApplicationNotExist', 'errorMessage' => 'The layer -4 accelerated application of the current operation does not exist. Modify it and try again.', 'description' => 'The layer -4 accelerated application of the current operation does not exist. Modify it and try again.'], + ['errorCode' => 'TransportLayerRulesExceedLimit', 'errorMessage' => 'The configured forwarding rules have exceeded the maximum limit. Delete useless forwarding rules and try again.', 'description' => 'The configured forwarding rules have exceeded the maximum limit. Delete useless forwarding rules and try again.'], + ['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' => '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.'], + ['errorCode' => 'InvalidParameter.InvalidRecordName', 'errorMessage' => 'The record name you entered does not meet the specifications. Change the record name according to the product documentation.', 'description' => 'The record name you entered does not meet the specifications. Please adjust the record name according to the product documentation.'], + ['errorCode' => 'EdgePortsOverlap', 'errorMessage' => 'There is overlap between multiple edge ports, please check and try again after modification.', 'description' => 'There is overlap between multiple edge ports, please check and try again after modification.'], + ['errorCode' => 'InvalidParameter.ClientIpPassThroughMode', 'errorMessage' => 'Invalid client IP transfer protocol, please refer to the interface document and pass in valid parameters.', 'description' => 'Invalid client IP transfer protocol, please refer to the interface document and pass in valid parameters.'], + ['errorCode' => 'InvalidParameter.RuleSource', 'errorMessage' => 'The origin of the forwarding rule does not exist or is invalid. Enter the correct origin and try again.', 'description' => 'The origin of the forwarding rule does not exist or is invalid. Enter the correct origin and try again.'], + ['errorCode' => 'InvalidParameter.Port', 'errorMessage' => 'Invalid edge port or origin port. Enter a valid port as required in the interface document.', 'description' => 'Invalid edge port or origin port. Enter a valid port as required in the interface document.'], + ['errorCode' => 'InvalidParameter.Protocol', 'errorMessage' => 'Invalid port protocol. Enter a valid port protocol as required by the interface documentation.', 'description' => 'Invalid port protocol. Enter a valid port protocol as required by the interface documentation.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], + ['errorCode' => 'IpaNotActive', 'errorMessage' => 'The ipa application is not active.', 'description' => 'The ipa application is not active.'], + ['errorCode' => 'Record.NoResource', 'errorMessage' => 'Failed to allocate resources for the record. Please submit a ticket for processing.', 'description' => 'Failed to allocate resources for the record. Please submit a work order for processing.'], + ['errorCode' => 'InvalidParameter.PrivateIpAsSourceUnsupported', 'errorMessage' => 'The provided source is an invalid private IP address. Please verify and resubmit.', 'description' => 'The provided source is an invalid private IP address. Please verify and resubmit.'], + ['errorCode' => 'InvalidParameter.SourceIpInBlacklist', 'errorMessage' => 'The provided source is an invalid private IP address. Please verify and resubmit.', 'description' => 'The provided source is an invalid private IP address. Please verify and resubmit.'], + ['errorCode' => 'IPA.KeepAliveProtectionConflict', 'errorMessage' => 'KeepAliveProtection is conflicted with StaticIp and CrossBorderOptimization, can not open at same time.', 'description' => 'KeepAliveProtection is conflicted with StaticIp and CrossBorderOptimization, can not open at same time'], + ['errorCode' => 'IPA.CanNotEnableKeepAliveProtection', 'errorMessage' => 'The site has one or more TCP/UDP proxied applications with keep-alive-protection enabled. Its acceleration region or plan can\'t be edited.', 'description' => 'DDoS protection for Chinese mainland or outside the Chinese mainland can\'t be "Basic protection"'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9e5448c7-edaf-49aa-9887-0fcd0832306c\\"\\n}","type":"json"}]', + 'title' => 'Update a layer 4 acceleration application', + 'description' => 'If ListTransportLayerApplications returns an empty Layer 4 acceleration application list, use CreateTransportLayerApplication to create a Layer 4 acceleration application, and then use this API to modify the configurations of the Layer 4 acceleration application.'."\n" + ."\n" + .'When creating a Layer 4 acceleration application, the selected site must be an activated site. After creating a site, call the VerifySite API to verify it. A site that passes verification is automatically activated, indicated by the response parameter Passed=true.', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTransportLayerApplication'], + ], ], 'ramActions' => [ [ @@ -93123,27 +52265,17 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9e5448c7-edaf-49aa-9887-0fcd0832306c\\"\\n}","type":"json"}]', ], 'UpdateUrlObservation' => [ - 'summary' => 'Updates the webpage monitoring configuration.', + 'summary' => 'Updates the URL observation configuration.', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -93156,49 +52288,31 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '264795', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the configuration. You can call the [ListUrlObservations](~~ListUrlObservations~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID. You can call the [ListUrlObservations](~~ListUrlObservations~~) operation to obtain the configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '35281609698****', 'title' => ''], ], [ 'name' => 'SdkType', 'in' => 'query', 'schema' => [ - 'description' => 'SDK integration. Valid values:'."\n" + 'description' => 'The SDK integration method. Valid values:'."\n" ."\n" - .'* **automatic** (Recommended)'."\n" - .'* **manual**'."\n", + .'- **automatic**: automatic integration.'."\n" + .'- **manual**: manual integration.', + 'enumValueTitles' => ['automatic' => 'Automatic integration.', 'manual' => 'Manual integration.'], 'type' => 'string', 'required' => true, - 'enum' => [ - 'automatic', - 'manual', - ], + 'enum' => ['automatic', 'manual'], 'example' => 'manual', 'title' => '', ], @@ -93207,16 +52321,11 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n", - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n"], ], 'example' => '', ], @@ -93224,164 +52333,48 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - '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' => '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.', - ], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The number of configuration items for the current function has exceeded the upper limit set by the system.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['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' => '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.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\\\n\\"\\n}","type":"json"}]', - 'title' => 'UpdateUrlObservation', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'Update URL observation configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateUrlObservation', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUrlObservation'], ], ], 'ramActions' => [ @@ -93392,25 +52385,15 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], ], 'UpdateUserDeliveryTask' => [ - 'summary' => 'Modifies the configurations of a delivery task, including the task name, log field, log category, and discard rate.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -93423,98 +52406,57 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239266', - 'abilityTreeNodes' => [ - 'FEATUREdcdn9K10I1', - ], + 'abilityTreeNodes' => ['FEATUREdcdn9K10I1'], ], 'parameters' => [ [ 'name' => 'TaskName', 'in' => 'formData', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '', - 'description' => 'The name of the delivery task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_project', - ], + 'schema' => ['description' => 'The task name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test_project'], ], [ 'name' => 'FieldName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The log fields that you want to include in logs to be delivered. Separate the log fields with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ClientRequestID,ClientRequestHost', - 'title' => '', - ], + 'schema' => ['description' => 'The selected fields. Separate multiple fields with a comma.', 'type' => 'string', 'required' => true, 'example' => 'ClientRequestID,ClientRequestHost', 'title' => ''], ], [ 'name' => 'BusinessType', 'in' => 'formData', - 'schema' => [ - 'description' => 'The log category. Valid values:'."\n" - ."\n" - .'* dcdn_log_access_l1 (default): access logs.'."\n" - .'* dcdn_log_er: Edge Routine logs.'."\n" - .'* dcdn_log_waf: firewall logs.'."\n" - .'* dcdn_log_ipa: TCP/UDP proxy logs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dcdn_log_er', - 'title' => '', - ], + 'schema' => ['description' => 'The real-time log type. Valid values:'."\n" + ."\n" + .'- **dcdn\\_log\\_access\\_l1 (default)**: access log.'."\n" + ."\n" + .'- **dcdn\\_log\\_er**: edge function log.'."\n" + ."\n" + .'- **dcdn\\_log\\_waf**: WAF log.'."\n" + ."\n" + .'- **dcdn\\_log\\_ipa**: layer 4 acceleration log.', 'type' => 'string', 'required' => false, 'example' => 'dcdn_log_er', 'title' => ''], ], [ 'name' => 'DiscardRate', 'in' => 'formData', - 'schema' => [ - 'description' => 'The discard rate. Default value: 0.'."\n", - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The default value is 0.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'Details', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'FilterVer', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD'], ], 'example' => '', ], @@ -93522,56 +52464,25 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], ], 403 => [ - [ - 'errorCode' => 'EsaService.NotOpen', - 'errorMessage' => 'ESA service has not opend.', - 'description' => 'Edge Security Accelerator (ESA) is not turned on', - ], + ['errorCode' => 'EsaService.NotOpen', 'errorMessage' => 'ESA service has not opend.', 'description' => 'Edge Security Accelerator (ESA) is not turned on'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34DCBC8A-****-****-****-6DAA11D7DDBD\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UpdateUserDeliveryTask', + 'summary' => 'Updates a delivery task configuration. You can modify the task name, selected fields, real-time log type, and discard rate.', 'changeSet' => [ - [ - 'createdAt' => '2025-06-24T01:43:11.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-12-26T08:21:56.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-10-18T01:07:11.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-27T05:57:02.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-06-24T01:43:11.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-26T08:21:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-10-18T01:07:11.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-27T05:57:02.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateUserDeliveryTask', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUserDeliveryTask'], ], ], 'ramActions' => [ @@ -93582,25 +52493,17 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34DCBC8A-****-****-****-6DAA11D7DDBD\\"\\n}","type":"json"}]', ], 'UpdateUserDeliveryTaskStatus' => [ 'summary' => 'Changes the status of a delivery task in your Alibaba Cloud account.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -93613,60 +52516,31 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238917', - 'abilityTreeNodes' => [ - 'FEATUREdcdn9K10I1', - ], + 'abilityTreeNodes' => ['FEATUREdcdn9K10I1'], ], 'parameters' => [ [ 'name' => 'TaskName', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '', - 'description' => 'The name of the delivery task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_project', - ], + 'schema' => ['description' => 'The name of the delivery task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test_project'], ], [ 'name' => 'Method', 'in' => 'query', - 'schema' => [ - 'description' => 'Enables or disables the delivery task. Valid values: online and offline.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'online', - 'title' => '', - ], + 'schema' => ['description' => 'Enables or disables the delivery task. Valid values: online and offline.', 'type' => 'string', 'required' => true, 'example' => 'online', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD', - ], - 'TaskName' => [ - 'description' => 'The name of the delivery task.'."\n", - 'type' => 'string', - 'example' => 'test_project', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the delivery task.'."\n", - 'type' => 'string', - 'example' => 'online', - 'title' => '', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '34DCBC8A-****-****-****-6DAA11D7DDBD'], + 'TaskName' => ['description' => 'The name of the delivery task.', 'type' => 'string', 'example' => 'test_project', 'title' => ''], + 'Status' => ['description' => 'The status of the delivery task.', 'type' => 'string', 'example' => 'online', 'title' => ''], ], 'example' => '', ], @@ -93674,51 +52548,29 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal exception occurred, please try again later.', - 'description' => 'An inner exception was triggered. Please try again later.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal exception occurred, please try again later.', 'description' => 'An inner exception was triggered. Please try again later.'], ], 403 => [ - [ - 'errorCode' => 'EsaService.NotOpen', - 'errorMessage' => 'ESA service has not opend.', - 'description' => 'Edge Security Accelerator (ESA) is not turned on', - ], + ['errorCode' => 'EsaService.NotOpen', 'errorMessage' => 'ESA service has not opend.', 'description' => 'Edge Security Accelerator (ESA) is not turned on'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34DCBC8A-****-****-****-6DAA11D7DDBD\\",\\n \\"TaskName\\": \\"test_project\\",\\n \\"Status\\": \\"online\\"\\n}","type":"json"}]', 'title' => 'UpdateUserDeliveryTaskStatus', 'description' => '## [](#)'."\n" ."\n" - .'You can call this operation to enable or disable a delivery task by using TaskName and Method. The response includes the most recent status and operation result details of the task.'."\n", + .'Use this operation to enable or disable a delivery task by using TaskName and Method. The response includes the most recent status and operation result details of the task.', 'changeSet' => [ - [ - 'createdAt' => '2024-10-18T01:07:11.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-27T05:57:02.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-10-18T01:07:11.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-27T05:57:02.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateUserDeliveryTaskStatus', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUserDeliveryTaskStatus'], ], ], 'ramActions' => [ @@ -93729,20 +52581,12 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34DCBC8A-****-****-****-6DAA11D7DDBD\\",\\n \\"TaskName\\": \\"test_project\\",\\n \\"Status\\": \\"online\\"\\n}","type":"json"}]', ], 'UpdateUserWafRuleset' => [ 'summary' => 'Modifies the WAF ruleset configuration for a specified instance, including its position, name, and other properties.', @@ -93753,13 +52597,8 @@ .'- Include only the parameters that you want to modify. Omit parameters that you do not want to change.'."\n" ."\n" .'- Note: Before you call this operation, ensure that the `InstanceId` and `Id` values are correct. Otherwise, the request may fail.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -93771,105 +52610,49 @@ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdcdnV3YEJ8', - 'FEATUREdcdnUTRW1O', - 'FEATUREdcdnSU2QP6', - 'FEATUREdcdnV3G3FZ', - 'FEATUREdcdnBQ0J3E', - ], + 'abilityTreeNodes' => ['FEATUREdcdnV3YEJ8', 'FEATUREdcdnUTRW1O', 'FEATUREdcdnSU2QP6', 'FEATUREdcdnV3G3FZ', 'FEATUREdcdnBQ0J3E'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'esa-xxxxxxx', - 'title' => '', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'esa-xxxxxxx', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => 'The WAF ruleset ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10000001', - 'title' => '', - ], + 'schema' => ['description' => 'The WAF ruleset ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000001', 'title' => ''], ], [ 'name' => 'Position', 'in' => 'formData', - 'schema' => [ - 'description' => 'The position of the WAF ruleset.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The position of the WAF ruleset.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the WAF ruleset.', - 'type' => 'string', - 'required' => false, - 'example' => 'example', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the WAF ruleset.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the WAF ruleset.', - 'type' => 'string', - 'required' => false, - 'example' => 'example', - 'title' => '', - ], + 'schema' => ['description' => 'The description of the WAF ruleset.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'formData', - 'schema' => [ - 'description' => 'The status of the WAF ruleset.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'The status of the WAF ruleset.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'Expression', 'in' => 'formData', - 'schema' => [ - 'description' => 'The expression of the WAF ruleset.', - 'type' => 'string', - 'required' => false, - 'example' => 'ip.src == 1.1.1.1', - 'title' => '', - ], + 'schema' => ['description' => 'The expression of the WAF ruleset.', 'type' => 'string', 'required' => false, 'example' => 'ip.src == 1.1.1.1', 'title' => ''], ], [ 'name' => 'Shared', 'in' => 'formData', 'style' => 'json', - 'schema' => [ - 'description' => 'The shared configuration of the WAF ruleset.', - '$ref' => '#/components/schemas/WafBatchRuleShared', - 'required' => false, - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The shared configuration of the WAF ruleset.', '$ref' => '#/components/schemas/WafBatchRuleShared', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'Rules', @@ -93878,13 +52661,7 @@ 'schema' => [ 'description' => 'A list of rule configurations in the WAF ruleset.', 'type' => 'array', - 'items' => [ - 'description' => 'A rule configuration in the WAF ruleset.', - '$ref' => '#/components/schemas/WafRuleConfig', - 'required' => false, - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'A rule configuration in the WAF ruleset.', '$ref' => '#/components/schemas/WafRuleConfig', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, 'example' => '['."\n" .' {'."\n" @@ -93905,12 +52682,7 @@ 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => 'xxxx-xxxx-xxxx-xxxx', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxx', 'title' => ''], ], 'example' => '', ], @@ -93918,58 +52690,20 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], ], 403 => [ - [ - 'errorCode' => 'Rule.Config.Noncompliance', - 'errorMessage' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', - 'description' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', - ], - [ - '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' => 'The format of the rule configuration is invalid.Check the configuration for syntax errors or structural inconsistencies and correct them to meet the requirements.', - ], - [ - 'errorCode' => '%s.NotSupport', - 'errorMessage' => 'The specified resource type %s is not supported.', - 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.', - ], - [ - 'errorCode' => '%s.OverQuota', - 'errorMessage' => 'The quantity of %s exceeds the quota.', - 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.', - ], - [ - 'errorCode' => '%s.WrongValueMatched', - 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', - 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.', - ], - [ - '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' => '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.', - ], + ['errorCode' => 'Rule.Config.Noncompliance', 'errorMessage' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', 'description' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.'], + ['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' => 'The format of the rule configuration is invalid.Check the configuration for syntax errors or structural inconsistencies and correct them to meet the requirements.'], + ['errorCode' => '%s.NotSupport', 'errorMessage' => 'The specified resource type %s is not supported.', 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.'], + ['errorCode' => '%s.OverQuota', 'errorMessage' => 'The quantity of %s exceeds the quota.', 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.'], + ['errorCode' => '%s.WrongValueMatched', 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.'], + ['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' => '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.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxx-xxxx-xxxx-xxxx\\"\\n}","type":"json"}]', 'title' => 'UpdateUserWafRuleset', 'changeSet' => [], @@ -93984,25 +52718,16 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'UpdateVideoProcessing' => [ - 'summary' => 'Modifies the video processing configuration of the site.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Modifies the video processing configuration of a website.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -94015,60 +52740,35 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '257664', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the configuration. You can call the [ListVideoProcessings](~~ListVideoProcessings~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '35281609698****', - 'title' => '', - ], + 'schema' => ['description' => 'The configuration ID. You can call the [ListVideoProcessings](~~ListVideoProcessings~~) operation to obtain the configuration ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '35281609698****', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'The rule name. You do not need to set this parameter when you add global configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rule_example', - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. You do not need to set this parameter when adding a global configuration.', 'type' => 'string', 'required' => false, 'example' => 'rule_example', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", + 'description' => 'The rule switch. You do not need to set this parameter when adding a global configuration. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', + 'enumValueTitles' => ['off' => 'Disabled.', 'on' => 'Enabled.'], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, - 'enum' => [ - 'on', - 'off', - ], 'example' => 'on', 'title' => '', ], @@ -94076,115 +52776,58 @@ [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Two scenarios:'."\n" - ."\n" - .'* true: Match all incoming requests'."\n" - .'* Set the value to a custom expression, for example: (http.host eq "video.example.com"): Match the specified request'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '(http.host eq "video.example.com")', - 'title' => '', - ], + 'schema' => ['description' => 'The rule content, which uses a conditional expression to match user requests. You do not need to set this parameter when adding a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: set the value to true.'."\n" + .'- Match specified requests: set the value to a custom expression, such as (http.host eq \\"video.example.com\\").', 'type' => 'string', 'required' => false, 'example' => '(http.host eq "video.example.com")', 'title' => ''], ], [ 'name' => 'Sequence', 'in' => 'query', - 'schema' => [ - 'description' => 'The order in which the rule is executed. A smaller value gives priority to the rule.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '', - ], + 'schema' => ['description' => 'The rule execution order. A smaller value indicates a higher priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'VideoSeekEnable', 'in' => 'query', - 'schema' => [ - 'description' => 'Video seeking. Valid values:'."\n" - ."\n" - .'* on'."\n" - .'* off'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable the video seeking feature. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ 'name' => 'FlvVideoSeekMode', 'in' => 'query', - 'schema' => [ - 'description' => 'FLV Seeking Valid values:'."\n" - ."\n" - .'* by_byte: Seek by byte.'."\n" - .'* by_time: Seek by time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'by_byte', - 'title' => '', - ], + 'schema' => ['description' => 'The FLV seeking mode. Valid values:'."\n" + .'- by_byte: seek by byte.'."\n" + .'- by_time: seek by time.', 'type' => 'string', 'required' => false, 'example' => 'by_byte', 'title' => ''], ], [ 'name' => 'Mp4SeekStart', 'in' => 'query', - 'schema' => [ - 'description' => 'Customize the mp4 start parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'start', - 'title' => '', - ], + 'schema' => ['description' => 'The custom MP4 start parameter.', 'type' => 'string', 'required' => false, 'example' => 'start', 'title' => ''], ], [ 'name' => 'Mp4SeekEnd', 'in' => 'query', - 'schema' => [ - 'description' => 'Customize the mp4 end parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'end', - 'title' => '', - ], + 'schema' => ['description' => 'The custom MP4 end parameter.', 'type' => 'string', 'required' => false, 'example' => 'end', 'title' => ''], ], [ 'name' => 'FlvSeekStart', 'in' => 'query', - 'schema' => [ - 'description' => 'The custom start parameter for FLV files.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'start', - 'title' => '', - ], + 'schema' => ['description' => 'The custom FLV start parameter.', 'type' => 'string', 'required' => false, 'example' => 'start', 'title' => ''], ], [ 'name' => 'FlvSeekEnd', 'in' => 'query', - 'schema' => [ - 'description' => 'The custom end parameter for FLV files.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'end', - 'title' => '', - ], + 'schema' => ['description' => 'The custom FLV end parameter.', 'type' => 'string', 'required' => false, 'example' => 'end', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3558df77-8a7a-4060-a900-2d7949403836', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '3558df77-8a7a-4060-a900-2d7949403836'], ], 'example' => '', ], @@ -94192,154 +52835,45 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ApplyVipError', - 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', - 'description' => 'Failed to apply for IP resources, please contact customer service.', - ], - [ - 'errorCode' => 'CanNotSetSequence', - 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', - 'description' => 'Sequence parameters is not allowed in global configuration.', - ], - [ - '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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.', - ], - [ - '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'errorCode' => 'VersionNotValid', - 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.Configs', - 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - 'errorCode' => 'InvalidParameter.FunctionName', - 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'IllegalOperation.VersionManagement', - 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.VersionManagement', - 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - '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' => '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.', - ], - [ - '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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], + ['errorCode' => 'ApplyVipError', 'errorMessage' => 'Failed to apply for ip resources, please contact customer service.', 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['errorCode' => 'CanNotSetSequence', 'errorMessage' => 'Non-regular configuration, you cannot set Sequence parameters.', 'description' => 'Sequence parameters is not allowed in global configuration.'], + ['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' => 'The number of sites for which the cache reserve instance bindings exceeds the limit.'], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], + ['errorCode' => 'VersionNotValid', 'errorMessage' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['errorCode' => 'InvalidParameter.Configs', 'errorMessage' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', 'description' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['errorCode' => 'InvalidParameter.FunctionName', 'errorMessage' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'IllegalOperation.VersionManagement', 'errorMessage' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', 'description' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['errorCode' => 'QuotaCheckFailed.VersionManagement', 'errorMessage' => 'Insufficient quota for version management. Contact technical support.', 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['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' => '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.'], + ['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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'UpdateVideoProcessing', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3558df77-8a7a-4060-a900-2d7949403836\\"\\n}","type":"json"}]', + 'title' => 'Modify site video processing configuration', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateVideoProcessing'], + ], ], 'ramActions' => [ [ @@ -94349,27 +52883,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => 'Update WAF Rule Page', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Updates a web application firewall (WAF) rule. Use this operation to modify the rule\'s configuration and status.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -94382,106 +52905,50 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239582', - 'abilityTreeNodes' => [ - 'FEATUREdcdnV3YEJ8', - 'FEATUREdcdnUTRW1O', - 'FEATUREdcdnSU2QP6', - 'FEATUREdcdnV3G3FZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdnV3YEJ8', 'FEATUREdcdnUTRW1O', 'FEATUREdcdnSU2QP6', 'FEATUREdcdnV3G3FZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'title' => '站点ID', - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '站点ID', 'description' => 'The ID of the site. To obtain the site ID, call the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Site version.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. For sites with configuration version management enabled, use this parameter to specify the effective configuration version. The default is version 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'title' => '规则ID', - 'description' => 'WAF rule ID, which can be obtained by calling the [ListWafRules](~~2878257~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20000001', - ], + 'schema' => ['title' => '规则ID', 'description' => 'The ID of the WAF rule. To obtain the rule ID, call the [ListWafRules](~~2878257~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20000001'], ], [ 'name' => 'Position', 'in' => 'formData', - 'schema' => [ - 'title' => '规则在规则集中的位置顺序', - 'description' => 'The position of the rule in the rule set.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '规则在规则集中的位置顺序', 'description' => 'The position of the rule within the rule set.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'Status', 'in' => 'formData', - 'schema' => [ - 'title' => '规则状态', - 'description' => 'Rule status.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - ], + 'schema' => ['title' => '规则状态', 'description' => 'The status of the rule.', 'type' => 'string', 'required' => false, 'example' => 'on'], ], [ 'name' => 'Config', 'in' => 'formData', 'style' => 'json', - 'schema' => [ - 'title' => '规则配置', - 'description' => 'Rule configuration.', - 'required' => false, - '$ref' => '#/components/schemas/WafRuleConfig', - 'example' => '', - ], + 'schema' => ['title' => '规则配置', 'description' => 'The configuration of the rule.', '$ref' => '#/components/schemas/WafRuleConfig', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], - 'Id' => [ - 'description' => 'WAF rule ID, which can be obtained by calling the [ListWafRules](~~2878257~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20000001', - 'title' => '', - ], + 'RequestId' => ['title' => '请求ID', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], + 'Id' => ['description' => 'The ID of the WAF rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '20000001', 'title' => ''], ], 'example' => '', ], @@ -94489,92 +52956,32 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'Rule.NotExist', - 'errorMessage' => 'The specified rule does not exist.', - 'description' => 'The specified rule does not exist in the current context or system configuration. Please verify the existence of the rule identifier and ensure it has been correctly defined or implemented.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'Rule.NotExist', 'errorMessage' => 'The specified rule does not exist.', 'description' => 'The specified rule does not exist in the current context or system configuration. Please verify the existence of the rule identifier and ensure it has been correctly defined or implemented.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], ], 403 => [ - [ - 'errorCode' => '%s.NotSupport', - 'errorMessage' => 'The specified resource type %s is not supported.', - 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.', - ], - [ - 'errorCode' => '%s.OverQuota', - 'errorMessage' => 'The quantity of %s exceeds the quota.', - 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.', - ], - [ - 'errorCode' => '%s.WrongValueMatched', - 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', - 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.', - ], - [ - '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' => 'The format of the rule configuration is invalid.Check the configuration for syntax errors or structural inconsistencies and correct them to meet the requirements.', - ], - [ - 'errorCode' => 'Rule.Config.Noncompliance', - 'errorMessage' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', - 'description' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', - ], - [ - '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' => 'The specified position for the rule is invalid.Check and adjust the configuration to make sure it meets the requirements.', - ], - [ - 'errorCode' => 'Rule.Name.AlreadyExists', - 'errorMessage' => 'The specified rule name already exists.Try again with a unique name or modify the existing rule name.', - 'description' => 'The specified rule name already exists.Try again with a unique name or modify the existing rule name.', - ], - [ - 'errorCode' => 'Expression.Invalid', - 'errorMessage' => 'The specified expression is invalid: %s.', - 'description' => 'The specified expression is invalid.', - ], + ['errorCode' => '%s.NotSupport', 'errorMessage' => 'The specified resource type %s is not supported.', 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.'], + ['errorCode' => '%s.OverQuota', 'errorMessage' => 'The quantity of %s exceeds the quota.', 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.'], + ['errorCode' => '%s.WrongValueMatched', 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.'], + ['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' => 'The format of the rule configuration is invalid.Check the configuration for syntax errors or structural inconsistencies and correct them to meet the requirements.'], + ['errorCode' => 'Rule.Config.Noncompliance', 'errorMessage' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', 'description' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.'], + ['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' => 'The specified position for the rule is invalid.Check and adjust the configuration to make sure it meets the requirements.'], + ['errorCode' => 'Rule.Name.AlreadyExists', 'errorMessage' => 'The specified rule name already exists.Try again with a unique name or modify the existing rule name.', 'description' => 'The specified rule name already exists.Try again with a unique name or modify the existing rule name.'], + ['errorCode' => 'Expression.Invalid', 'errorMessage' => 'The specified expression is invalid: %s.', 'description' => 'The specified expression is invalid.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\",\\n \\"Id\\": 20000001\\n}","type":"json"}]', 'title' => 'Update WAF Rule', 'changeSet' => [ - [ - 'createdAt' => '2024-09-25T07:02:49.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T06:13:33.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-25T07:02:49.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T06:13:33.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateWafRule', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWafRule'], ], ], 'ramActions' => [ @@ -94585,27 +52992,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => 'Update WAF Ruleset', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Updates a WAF ruleset based on its ID.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -94618,73 +53014,38 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239645', - 'abilityTreeNodes' => [ - 'FEATUREdcdnBQ0J3E', - 'FEATUREdcdn1OLUH8', - ], + 'abilityTreeNodes' => ['FEATUREdcdnBQ0J3E', 'FEATUREdcdn1OLUH8'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'title' => '站点ID', - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '站点ID', 'description' => 'The ID of the site. You can obtain this ID by calling the [ListSites](~~2850189~~) API.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ 'name' => 'SiteVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Site version.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The version number of the site configuration. For a site with configuration version management enabled, this parameter specifies the version to update. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'title' => '规则集ID', - 'description' => 'ID of the WAF ruleset, which can be obtained by calling the [ListWafRulesets](~~2878359~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10000001', - ], + 'schema' => ['title' => '规则集ID', 'description' => 'The WAF ruleset ID. You can obtain this ID by calling the [ListWafRulesets](~~2878359~~) API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000001'], ], [ 'name' => 'Status', 'in' => 'formData', - 'schema' => [ - 'title' => '规则集状态', - 'description' => 'The target status to change for the ruleset.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - ], + 'schema' => ['title' => '规则集状态', 'description' => 'The target status of the ruleset.', 'type' => 'string', 'required' => false, 'example' => 'on'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - ], + 'RequestId' => ['title' => '请求ID', 'description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225'], ], 'example' => '', ], @@ -94692,68 +53053,27 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'SpecifiedVersionReadOnly', - 'errorMessage' => 'The specified version number is read-only and cannot be modified.', - 'description' => 'The specified version number is read-only and cannot be modified.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'SpecifiedVersionReadOnly', 'errorMessage' => 'The specified version number is read-only and cannot be modified.', 'description' => 'The specified version number is read-only and cannot be modified.'], ], 403 => [ - [ - 'errorCode' => '%s.NotSupport', - 'errorMessage' => 'The specified resource type %s is not supported.', - 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.', - ], - [ - 'errorCode' => '%s.OverQuota', - 'errorMessage' => 'The quantity of %s exceeds the quota.', - 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.', - ], - [ - 'errorCode' => '%s.WrongValueMatched', - 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', - 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.', - ], - [ - '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' => '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.', - ], + ['errorCode' => '%s.NotSupport', 'errorMessage' => 'The specified resource type %s is not supported.', 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.'], + ['errorCode' => '%s.OverQuota', 'errorMessage' => 'The quantity of %s exceeds the quota.', 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.'], + ['errorCode' => '%s.WrongValueMatched', 'errorMessage' => 'The value of specified parameter %s can not pass the matching check.', 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.'], + ['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' => '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.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36af3fcc-43d0-441c-86b1-428951dc8225\\"\\n}","type":"json"}]', 'title' => 'Update WAF Ruleset', 'changeSet' => [ - [ - 'createdAt' => '2024-09-25T07:02:49.000Z', - 'description' => 'Error codes changed', - ], - [ - 'createdAt' => '2024-09-18T06:13:38.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-25T07:02:49.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-09-18T06:13:38.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateWafRuleset', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWafRuleset'], ], ], 'ramActions' => [ @@ -94764,25 +53084,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], ], 'UpdateWaitingRoom' => [ - 'summary' => 'Modifies the configurations of a waiting room.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Updates the configuration of a specified waiting room.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -94795,79 +53106,54 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239629', - 'abilityTreeNodes' => [ - 'FEATUREdcdnO4KC7Z', - ], + 'abilityTreeNodes' => ['FEATUREdcdnO4KC7Z'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '7096621098****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7096621098****', 'title' => ''], ], [ 'name' => 'WaitingRoomId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the waiting room, which can be obtained by calling the [ListWaitingRooms](~~2850279~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '6a51d5bc6460887abd129****', - 'title' => '', - ], + 'schema' => ['description' => 'The waiting room ID, which can be obtained by calling the [ListWaitingRooms](~~2850279~~) operation.', 'type' => 'string', 'required' => true, 'example' => '6a51d5bc6460887abd129****', 'title' => ''], ], [ 'name' => 'Enable', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable the waiting room. Valid values:'."\n" + 'description' => 'The status of the waiting room. Valid values:'."\n" ."\n" - .'* on'."\n" - .'* off'."\n", + .' - **on**: Enabled.'."\n" + .' - **off**: Disabled.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, + 'enum' => ['on', 'off'], 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the waiting room.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '节假日促销等候室', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the waiting room.', 'type' => 'string', 'required' => false, 'example' => '节假日促销等候室', 'title' => ''], ], [ 'name' => 'QueueAllEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to queue all requests. Valid values:'."\n" + 'description' => 'Specifies whether to queue all visitors. Valid values:'."\n" ."\n" - .'* on'."\n" - .'* off'."\n", + .'- **on**: Enabled.'."\n" + .'- **off**: Disabled.', + 'enumValueTitles' => [], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], @@ -94876,33 +53162,15 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The hostname and path.'."\n", + 'description' => 'The hostname and path configurations.', 'type' => 'array', 'items' => [ - 'description' => 'The details of the hostname and path.'."\n", + 'description' => 'The hostname and path details.', 'type' => 'object', 'properties' => [ - 'Subdomain' => [ - 'description' => 'The subdomain.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test.', - 'title' => '', - ], - 'Domain' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'example.com'."\n", - 'title' => '', - ], - 'Path' => [ - 'description' => 'The probe path.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/test'."\n", - 'title' => '', - ], + 'Subdomain' => ['description' => 'The subdomain.', 'type' => 'string', 'required' => false, 'example' => 'test.', 'title' => ''], + 'Domain' => ['description' => 'The domain name.', 'type' => 'string', 'required' => false, 'example' => 'example.com'."\n", 'title' => ''], + 'Path' => ['description' => 'The path.', 'type' => 'string', 'required' => false, 'example' => '/test'."\n", 'title' => ''], ], 'required' => false, 'title' => '', @@ -94916,46 +53184,22 @@ [ 'name' => 'CookieName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the custom cookie.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '__aliwaitingroom_example'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The custom cookie name.', 'type' => 'string', 'required' => false, 'example' => '__aliwaitingroom_example'."\n", 'title' => ''], ], [ 'name' => 'TotalActiveUsers', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of active users.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '300', - 'title' => '', - ], + 'schema' => ['description' => 'The total number of active users.', 'type' => 'string', 'required' => false, 'example' => '300', 'title' => ''], ], [ 'name' => 'NewUsersPerMinute', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of new users per minute.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '200', - 'title' => '', - ], + 'schema' => ['description' => 'The number of new users per minute.', 'type' => 'string', 'required' => false, 'example' => '200', 'title' => ''], ], [ 'name' => 'SessionDuration', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum duration for which a session remains valid after a user leaves the origin. Unit: minutes.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5', - 'title' => '', - ], + 'schema' => ['description' => 'The session duration in minutes.', 'type' => 'string', 'required' => false, 'example' => '5', 'title' => ''], ], [ 'name' => 'DisableSessionRenewalEnable', @@ -94963,15 +53207,13 @@ 'schema' => [ 'description' => 'Specifies whether to disable session renewal. Valid values:'."\n" ."\n" - .'* on'."\n" - .'* off'."\n", + .'- **on**: Enabled.'."\n" + .'- **off**: Disabled.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, + 'enum' => ['on', 'off'], 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], @@ -94981,19 +53223,15 @@ 'schema' => [ 'description' => 'The queuing method. Valid values:'."\n" ."\n" - .'* random: Users gain access to the origin randomly, regardless of the arrival time.'."\n" - .'* fifo: Users gain access to the origin in order of arrival.'."\n" - .'* passthrough: Users pass through the waiting room and go straight to the origin.'."\n" - .'* reject-all: Users are blocked from reaching the origin.'."\n", + .'- **random**: random.'."\n" + .'- **fifo**: first-in, first-out.'."\n" + .'- **passthrough**: passthrough.'."\n" + .'- **reject-all**: reject all.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, + 'enum' => ['fifo', 'random', 'passthrough', 'reject-all'], 'example' => 'random', - 'enum' => [ - 'fifo', - 'random', - 'passthrough', - 'reject-all', - ], 'title' => '', ], ], @@ -95001,19 +53239,16 @@ 'name' => 'QueuingStatusCode', 'in' => 'query', 'schema' => [ - 'description' => 'The HTTP status code to return while a user is in the queue. Valid values:'."\n" + 'description' => 'The HTTP status code returned by the waiting room. Valid values:'."\n" ."\n" - .'* 200'."\n" - .'* 202'."\n" - .'* 429'."\n", + .'- **200**'."\n" + .'- **202**'."\n" + .'- **429**', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, + 'enum' => ['200', '202', '429'], 'example' => '200', - 'enum' => [ - '200', - '202', - '429', - ], 'title' => '', ], ], @@ -95021,17 +53256,15 @@ 'name' => 'JsonResponseEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable JSON response. If JSON response is enabled, a JSON body is returned for requests to the waiting room with the header Accept: application/json. Valid values:'."\n" + 'description' => 'Specifies whether to enable JSON response. If enabled, requests with an Accept header containing "application/json" return JSON data. Valid values:'."\n" ."\n" - .'* on'."\n" - .'* off'."\n", + .'- **on**: Enabled.'."\n" + .'- **off**: Disabled.', + 'enumValueTitles' => [], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], @@ -95039,13 +53272,7 @@ 'name' => 'Description', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The description of the waiting room.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '特别活动排队页面', - 'title' => '', - ], + 'schema' => ['description' => 'The description of the waiting room.', 'type' => 'string', 'required' => false, 'example' => '特别活动排队页面', 'title' => ''], ], [ 'name' => 'WaitingRoomType', @@ -95053,15 +53280,13 @@ 'schema' => [ 'description' => 'The type of the waiting room. Valid values:'."\n" ."\n" - .'* default'."\n" - .'* custom'."\n", + .'- **default**: default type.'."\n" + .'- **custom**: custom type.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, + 'enum' => ['default', 'custom'], 'example' => 'default', - 'enum' => [ - 'default', - 'custom', - ], 'title' => '', ], ], @@ -95069,32 +53294,23 @@ 'name' => 'CustomPageHtml', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The content of the custom waiting room page. You must specify this parameter if you set WaitingRoomType to custom. The content must be Base64-encoded.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SGVsbG8gd29ybGQ=', - 'title' => '', - ], + 'schema' => ['description' => 'The custom waiting room page content. This parameter is required when the waiting room type is set to custom. The content must be in Base64 encoding.', 'type' => 'string', 'required' => false, 'example' => 'SGVsbG8gd29ybGQ=', 'title' => ''], ], [ 'name' => 'Language', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'The language of the waiting room page. You must specify this parameter if you set WaitingRoomType to default. Valid values:'."\n" + 'description' => 'The language of the waiting room page. This parameter is required when the waiting room type is set to default. Valid values:'."\n" ."\n" - .'* enus: English.'."\n" - .'* zhcn: Simplified Chinese.'."\n" - .'* zhhk: Traditional Chinese.'."\n", + .'- **enus**: English.'."\n" + .'- **zhcn**: Simplified Chinese.'."\n" + .'- **zhhk**: Traditional Chinese.', + 'enumValueTitles' => [], 'type' => 'string', + 'enum' => ['enus', 'zhcn', 'zhhk'], 'required' => false, 'example' => 'zhcn', - 'enum' => [ - 'enus', - 'zhcn', - 'zhhk', - ], 'title' => '', ], ], @@ -95102,16 +53318,11 @@ 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0195619f-eab3-4a66-ac00-ed53d913e72e', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0195619f-eab3-4a66-ac00-ed53d913e72e', 'title' => ''], ], + 'description' => '', 'title' => '', 'example' => '', ], @@ -95119,112 +53330,39 @@ ], '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - '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' => 'The waiting room that you want to modify does not exist or does not belong to you. Confirm and try again.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', - ], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['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' => 'The waiting room that you want to modify does not exist or does not belong to you. Confirm and try again.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'title' => 'UpdateWaitingRoom', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0195619f-eab3-4a66-ac00-ed53d913e72e\\"\\n}","type":"json"}]', + 'title' => 'Update a waiting room', 'changeSet' => [ - [ - 'createdAt' => '2024-09-18T06:13:38.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-18T06:13:38.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateWaitingRoom', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWaitingRoom'], ], ], 'ramActions' => [ @@ -95235,26 +53373,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => 'Modifies the configurations of a waiting room event.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Updates the configuration of a waiting room event.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -95267,97 +53395,56 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239617', - 'abilityTreeNodes' => [ - 'FEATUREdcdnVCBH9N', - ], + 'abilityTreeNodes' => ['FEATUREdcdnVCBH9N'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****'."\n", 'title' => ''], ], [ 'name' => 'WaitingRoomEventId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the waiting room event, which can be obtained by calling the [ListWaitingRoomEvents](~~2850279~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '89677721098****', - 'title' => '', - ], + 'schema' => ['description' => 'The waiting room event ID, which can be obtained by calling the [ListWaitingRoomEvents](~~2850279~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '89677721098****', 'title' => ''], ], [ 'name' => 'Enable', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable the waiting room event. Valid values:'."\n" + 'description' => 'The enabling status. Valid values:'."\n" ."\n" - .'* `on`'."\n" - .'* `off`'."\n", + .' - **on**: Enables the waiting room event.'."\n" + ."\n" + .' - **off**: Disables the waiting room event.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, + 'enum' => ['on', 'off'], 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the waiting room event.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '测试事件2', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the waiting room event.', 'type' => 'string', 'required' => false, 'example' => '测试事件2', 'title' => ''], ], [ 'name' => 'TotalActiveUsers', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of active users.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '200', - 'title' => '', - ], + 'schema' => ['description' => 'The total number of active users.', 'type' => 'string', 'required' => false, 'example' => '200', 'title' => ''], ], [ 'name' => 'NewUsersPerMinute', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of new users per minute.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '300', - 'title' => '', - ], + 'schema' => ['description' => 'The number of new users per minute.', 'type' => 'string', 'required' => false, 'example' => '300', 'title' => ''], ], [ 'name' => 'SessionDuration', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum duration for which a session remains valid after a user leaves the origin. Unit: minutes.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5', - 'title' => '', - ], + 'schema' => ['description' => 'The user session duration, in minutes.', 'type' => 'string', 'required' => false, 'example' => '5', 'title' => ''], ], [ 'name' => 'DisableSessionRenewalEnable', @@ -95365,15 +53452,13 @@ 'schema' => [ 'description' => 'Specifies whether to disable session renewal. Valid values:'."\n" ."\n" - .'* on'."\n" - .'* off'."\n", + .'- **on**: Enabled.'."\n" + .'- **off**: Disabled.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, + 'enum' => ['on', 'off'], 'example' => 'off', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], @@ -95383,19 +53468,15 @@ 'schema' => [ 'description' => 'The queuing method. Valid values:'."\n" ."\n" - .'* random: Users gain access to the origin randomly, regardless of the arrival time.'."\n" - .'* fifo: Users gain access to the origin in order of arrival.'."\n" - .'* passthrough: Users pass through the waiting room and go straight to the origin.'."\n" - .'* reject-all: All requests are blocked from accessing the origin.'."\n", + .'- **random**: random.'."\n" + .'- **fifo**: first-in, first-out.'."\n" + .'- **passthrough**: passthrough.'."\n" + .'- **reject-all**: reject all.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, + 'enum' => ['fifo', 'random', 'passthrough', 'reject-all'], 'example' => 'fifo', - 'enum' => [ - 'fifo', - 'random', - 'passthrough', - 'reject-all', - ], 'title' => '', ], ], @@ -95403,19 +53484,16 @@ 'name' => 'QueuingStatusCode', 'in' => 'query', 'schema' => [ - 'description' => 'The HTTP status code to return while a user is in the queue. Valid values:'."\n" + 'description' => 'The waiting room status code. Valid values:'."\n" ."\n" - .'* 200'."\n" - .'* 202'."\n" - .'* 429'."\n", + .'- **200**'."\n" + .'- **202**'."\n" + .'- **429**', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, + 'enum' => ['200', '202', '429'], 'example' => '200', - 'enum' => [ - '200', - '202', - '429', - ], 'title' => '', ], ], @@ -95425,15 +53503,13 @@ 'schema' => [ 'description' => 'Specifies whether to enable JSON response. Valid values:'."\n" ."\n" - .'* on'."\n" - .'* off'."\n", + .'- **on**: Enabled.'."\n" + .'- **off**: Disabled.', + 'enumValueTitles' => [], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, 'example' => 'off', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], @@ -95441,13 +53517,7 @@ 'name' => 'Description', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The description of the waiting room.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://yywyyw.com', - 'title' => '', - ], + 'schema' => ['description' => 'The description of the waiting room.', 'type' => 'string', 'required' => false, 'example' => 'http://yywyyw.com', 'title' => ''], ], [ 'name' => 'WaitingRoomType', @@ -95455,15 +53525,13 @@ 'schema' => [ 'description' => 'The type of the waiting room. Valid values:'."\n" ."\n" - .'* default'."\n" - .'* custom'."\n", + .'- **default**: default type.'."\n" + .'- **custom**: custom type.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, + 'enum' => ['default', 'custom'], 'example' => 'custom', - 'enum' => [ - 'default', - 'custom', - ], 'title' => '', ], ], @@ -95471,51 +53539,31 @@ 'name' => 'CustomPageHtml', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The content of the custom waiting room page. You must specify this parameter if you set WaitingRoomType to custom. The content must be Base64-encoded.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SGVsbG8gd29ybGQ=', - 'title' => '', - ], + 'schema' => ['description' => 'The custom waiting room page content. This parameter is required when the waiting room type is set to custom. The content must use Base64 encoding.', 'type' => 'string', 'required' => false, 'example' => 'SGVsbG8gd29ybGQ=', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The start time of the event. This value is a UNIX timestamp.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1719763200', - 'title' => '', - ], + 'schema' => ['description' => 'The timestamp of the event start time.', 'type' => 'string', 'required' => false, 'example' => '1719763200', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The end time of the event. This value is a UNIX timestamp.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1719849600', - 'title' => '', - ], + 'schema' => ['description' => 'The timestamp of the event end time.', 'type' => 'string', 'required' => false, 'example' => '1719849600', 'title' => ''], ], [ 'name' => 'PreQueueEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable pre-queuing.'."\n" + 'description' => 'Specifies whether to enable pre-queuing. Valid values:'."\n" ."\n" - .'* on'."\n" - .'* off'."\n", + .'- **on**: Enabled.'."\n" + .'- **off**: Disabled.', + 'enumValueTitles' => [], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], @@ -95523,29 +53571,21 @@ 'name' => 'PreQueueStartTime', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The start time for pre-queuing.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1719763200', - 'title' => '', - ], + 'schema' => ['description' => 'The timestamp of the pre-queuing start time.', 'type' => 'string', 'required' => false, 'example' => '1719763200', 'title' => ''], ], [ 'name' => 'RandomPreQueueEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable random queuing.'."\n" + 'description' => 'Specifies whether to enable random pre-queuing. Valid values:'."\n" ."\n" - .'* on'."\n" - .'* off'."\n", + .'- **on**: Enabled.'."\n" + .'- **off**: Disabled.', + 'enumValueTitles' => [], 'type' => 'string', + 'enum' => ['on', 'off'], 'required' => false, 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], @@ -95554,19 +53594,16 @@ 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'The default language. Valid values:'."\n" + 'description' => 'The default language setting. Valid values:'."\n" ."\n" - .'* `enus`: English.'."\n" - .'* `zhcn`: Simplified Chinese.'."\n" - .'* `zhhk`: Traditional Chinese.'."\n", + .' - **enus**: English.'."\n" + .'- **zhcn**: Simplified Chinese.'."\n" + .'- **zhhk**: Traditional Chinese.', + 'enumValueTitles' => [], 'type' => 'string', + 'enum' => ['enus', 'zhcn', 'zhhk'], 'required' => false, 'example' => 'enus', - 'enum' => [ - 'enus', - 'zhcn', - 'zhhk', - ], 'title' => '', ], ], @@ -95574,16 +53611,11 @@ 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0195619f-eab3-4a66-ac00-ed53d913e72e', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0195619f-eab3-4a66-ac00-ed53d913e72e', 'title' => ''], ], + 'description' => '', 'title' => '', 'example' => '', ], @@ -95591,114 +53623,37 @@ ], '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'InvalidConfigId', - 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', - 'description' => 'The ConfigId does not exist.', - ], - [ - 'errorCode' => 'WaitingRoomEventNotExist', - 'errorMessage' => 'The waiting room event that you want to modify does not exist. Specify a valid one.', - 'description' => 'The waiting room event that you want to modify does not exist. Specify a valid one.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', - ], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'InvalidConfigId', 'errorMessage' => 'The input configuration ID: ConfigId it does not exist, query the existing configuration and its valid ConfigId through the ListSiteFunction.', 'description' => 'The ConfigId does not exist.'], + ['errorCode' => 'WaitingRoomEventNotExist', 'errorMessage' => 'The waiting room event that you want to modify does not exist. Specify a valid one.', 'description' => 'The waiting room event that you want to modify does not exist. Specify a valid one.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'UpdateWaitingRoomEvent', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0195619f-eab3-4a66-ac00-ed53d913e72e\\"\\n}","type":"json"}]', + 'title' => 'Update a waiting room event', 'changeSet' => [ - [ - 'createdAt' => '2025-02-21T03:40:42.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-09-18T06:13:39.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-02-21T03:40:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-18T06:13:39.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateWaitingRoomEvent', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWaitingRoomEvent'], ], ], 'ramActions' => [ @@ -95709,29 +53664,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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"}]', - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], ], 'UpdateWaitingRoomRule' => [ - 'summary' => 'Modify Waiting Room Rule', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Updates the waiting room bypass rule configuration for a specified site.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -95744,91 +53686,60 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239642', - 'abilityTreeNodes' => [ - 'FEATUREdcdnA885EB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnA885EB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'Site ID, which can be obtained by calling the [ListSites](~~2850189~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~2850189~~) operation to obtain the site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456****', 'title' => ''], ], [ 'name' => 'WaitingRoomRuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the waiting room bypass rule to be updated, which can be obtained by calling the [ListWaitingRoomRules](~~2850279~~) interface.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '8987739839****', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the waiting room bypass rule to update. You can obtain this ID after creating a rule by calling CreateWaitingRoomRule, or by calling the [ListWaitingRoomRules](~~2850279~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '8987739839****', 'title' => ''], ], [ 'name' => 'RuleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule name. This parameter is not required when adding global configuration.', - 'type' => 'string', - 'required' => true, - 'example' => 'test1', - 'title' => '', - ], + 'schema' => ['description' => 'The rule name. This parameter is not required when you add a global configuration.', 'type' => 'string', 'required' => true, 'example' => 'test1', 'title' => ''], ], [ 'name' => 'RuleEnable', 'in' => 'query', 'schema' => [ - 'description' => 'Rule switch. This parameter is not required when adding global configuration. Value range:'."\n" - .'- on: Enable.'."\n" - .'- off: Disable.', + 'description' => 'Specifies whether to enable the rule. This parameter is not required when you add a global configuration. Valid values:'."\n" + .'- on: enabled.'."\n" + .'- off: disabled.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, + 'enum' => ['on', 'off'], 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], 'title' => '', ], ], [ 'name' => 'Rule', 'in' => 'query', - 'schema' => [ - 'description' => 'Rule content, using conditional expressions to match user requests. This parameter is not required when adding global configuration. There are two usage scenarios:'."\n" - .'- Match all incoming requests: Set the value to true'."\n" - .'- Match specific requests: Set the value to a custom expression, for example: (http.host eq "video.example.com")', - 'type' => 'string', - 'required' => true, - 'example' => '(http.request.uri.path.file_name eq \\"jpg\\")', - 'title' => '', - ], + 'schema' => ['description' => 'The rule content. A conditional expression is used to match user requests. This parameter is not required when you add a global configuration. Two scenarios are supported:'."\n" + .'- Match all incoming requests: set the value to true.'."\n" + .'- Match specified requests: set the value to a custom expression, for example, (http.host eq \\"video.example.com\\").'."\n" + ."\n" + .'For the complete syntax of rule expressions, refer to'."\n" + .'https://www.alibabacloud.com/help/en/edge-security-acceleration/esa/user-guide/work-with-rules-engine/'."\n" + .'https://www.alibabacloud.com/help/edge-security-acceleration/esa/user-guide/work-with-rules-engine/', 'type' => 'string', 'required' => true, 'example' => '(http.request.uri.path.file_name eq \\"jpg\\")', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Information returned upon successful response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID, used for tracking the progress of request processing.', - 'type' => 'string', - 'example' => '9bfe9d95-7bf6-469d-a628-ed7bc9f25073', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9bfe9d95-7bf6-469d-a628-ed7bc9f25073', 'title' => ''], ], + 'description' => '', 'title' => '', 'example' => '', ], @@ -95836,115 +53747,37 @@ ], '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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'errorCode' => 'FunctionConflict', - 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - '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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'errorCode' => 'InvalidParameter.ArgValue', - 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'errorCode' => 'LockFailed', - 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'errorCode' => 'WaitingRoomRuleNotExist', - 'errorMessage' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.', - 'description' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', - ], - [ - 'errorCode' => 'MissingParameter', - 'errorMessage' => 'The specified ArgName is required for this function.', - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], + ['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' => 'Rule compilation failed. Check the incoming rule configuration. For details, see the rule configuration format described in the interface document.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The parameter uniqueness check failed. Check for duplicate parameter values.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['errorCode' => 'FunctionConflict', 'errorMessage' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['errorCode' => 'InvalidParameter.ArgValue', 'errorMessage' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['errorCode' => 'LockFailed', 'errorMessage' => 'The system is handling requests you previously submitted. Try again later.', 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['errorCode' => 'WaitingRoomRuleNotExist', 'errorMessage' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.', 'description' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function 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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.'], + ['errorCode' => 'MissingParameter', 'errorMessage' => 'The specified ArgName is required for this function.', 'description' => 'When configuring a specific function, the required parameter is missing.'], ], 404 => [ - [ - 'errorCode' => 'SiteNotFound', - 'errorMessage' => 'The website does not exist or does not belong to you.', - 'description' => 'The website does not exist or does not belong to you.', - ], + ['errorCode' => 'SiteNotFound', 'errorMessage' => 'The website does not exist or does not belong to you.', 'description' => 'The website does not exist or does not belong to you.'], ], ], - 'title' => 'Modify Waiting Room Bypass Rule', - 'description' => 'This interface allows you to modify the rule settings of a specific waiting room in a site, including the rule name, enable status, and rule content, etc.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9bfe9d95-7bf6-469d-a628-ed7bc9f25073\\"\\n}","type":"json"}]', + 'title' => 'Update a waiting room bypass rule', + 'description' => 'Modifies the rule settings of a specific waiting room for a site, including the rule name, enabled status, and rule content.', 'changeSet' => [ - [ - 'createdAt' => '2025-02-21T03:40:42.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2024-09-18T06:13:39.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2025-02-21T03:40:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-18T06:13:39.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UpdateWaitingRoomRule', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWaitingRoomRule'], ], ], 'ramActions' => [ @@ -95955,26 +53788,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['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' => [ - 'summary' => 'Uploads a client certificate authority (CA) certificate.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Uploads a client CA certificate.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -95987,119 +53810,43 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239190', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], [ 'name' => 'Certificate', 'in' => 'formData', - 'schema' => [ - 'description' => 'The certificate content.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '-----BEGIN CERTIFICATE-----', - 'title' => '', - ], + 'schema' => ['description' => 'The certificate content.', 'type' => 'string', 'required' => true, 'example' => '-----BEGIN CERTIFICATE-----', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The certificate name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'yourCertName', - 'title' => '', - ], + 'schema' => ['description' => 'The certificate name.', 'type' => 'string', 'required' => false, 'example' => 'yourCertName', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - 'title' => '', - ], - 'Id' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'example' => 'baba39055622c008b90285a8838ed09a', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the certificate.'."\n", - 'type' => 'string', - 'example' => 'OK', - 'title' => '', - ], - 'CommonName' => [ - 'description' => 'The Common Name of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com', - 'title' => '', - ], - 'NotBefore' => [ - 'description' => 'The time when the certificate takes effect.'."\n", - 'type' => 'string', - 'example' => '2023-12-01T02:13:07Z', - 'title' => '', - ], - 'NotAfter' => [ - 'description' => 'The time when the certificate expires.'."\n", - 'type' => 'string', - 'example' => '2024-12-01T02:13:07Z', - 'title' => '', - ], - 'Issuer' => [ - 'description' => 'The CA that issued the certificate.'."\n", - 'type' => 'string', - 'example' => 'GlobalSign nv-sa', - 'title' => '', - ], - 'SerialNumber' => [ - 'description' => 'The serial number of the certificate.'."\n", - 'type' => 'string', - 'example' => 'babab9db65ee5efcca9f3d41d4b50d66', - 'title' => '', - ], - 'FingerprintSha256' => [ - 'description' => 'The SHA-256 fingerprint of the certificate.'."\n", - 'type' => 'string', - 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66', - 'title' => '', - ], - 'SignatureAlgorithm' => [ - 'description' => 'The signature algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'SHA256-RSA', - 'title' => '', - ], - 'ValidityDays' => [ - 'description' => 'The validity period of the certificate. Unit: day.'."\n", - 'type' => 'string', - 'example' => '300', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', 'title' => ''], + 'Id' => ['description' => 'The certificate ID.', 'type' => 'string', 'example' => 'baba39055622c008b90285a8838ed09a', 'title' => ''], + 'Status' => ['description' => 'The certificate status.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'CommonName' => ['description' => 'The common name of the certificate.', 'type' => 'string', 'example' => 'www.example.com', 'title' => ''], + 'NotBefore' => ['description' => 'The start time of the certificate validity period.', 'type' => 'string', 'example' => '2023-12-01T02:13:07Z', 'title' => ''], + 'NotAfter' => ['description' => 'The end time of the certificate validity period.', 'type' => 'string', 'example' => '2024-12-01T02:13:07Z', 'title' => ''], + 'Issuer' => ['description' => 'The certification authority.', 'type' => 'string', 'example' => 'GlobalSign nv-sa', 'title' => ''], + 'SerialNumber' => ['description' => 'The certificate serial number.', 'type' => 'string', 'example' => 'babab9db65ee5efcca9f3d41d4b50d66', 'title' => ''], + 'FingerprintSha256' => ['description' => 'The SHA-256 fingerprint of the certificate.', 'type' => 'string', 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66', 'title' => ''], + 'SignatureAlgorithm' => ['description' => 'The signature algorithm of the certificate.', 'type' => 'string', 'example' => 'SHA256-RSA', 'title' => ''], + 'ValidityDays' => ['description' => 'The number of days the certificate is valid.', 'type' => 'string', 'example' => '300', 'title' => ''], ], 'example' => '', ], @@ -96107,64 +53854,26 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Certificate.StatusError', - 'errorMessage' => 'The status of the certificate is invalid.', - 'description' => 'The specified certificate status is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.Function', - 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', - 'description' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], + ['errorCode' => 'Certificate.StatusError', 'errorMessage' => 'The status of the certificate is invalid.', 'description' => 'The specified certificate status is invalid.'], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'QuotaCheckFailed.Function', 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', 'description' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', - 'title' => 'UploadClientCaCertificate', + 'title' => 'Upload a client CA certificate', + 'requestParamsDescription' => 'The certificate content specified by the Certificate parameter must be in PEM format and must be a valid CA certificate within its validity period (X.509 extension basicConstraints: CA:TRUE).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UploadClientCaCertificate', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadClientCaCertificate'], ], ], 'ramActions' => [ @@ -96175,25 +53884,16 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], ], 'UploadFile' => [ - 'summary' => 'Uploads the file that contains resources to be purged or prefetched.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Uploads a refresh or prefetch file to improve access speed.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -96206,57 +53906,37 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239245', - 'abilityTreeNodes' => [ - 'FEATUREdcdnBCJPGN', - 'FEATUREdcdnRELTJV', - 'FEATUREdcdnEWYS3A', - 'FEATUREdcdn4TTNAL', - ], + 'abilityTreeNodes' => ['FEATUREdcdnBCJPGN', 'FEATUREdcdnRELTJV', 'FEATUREdcdnEWYS3A', 'FEATUREdcdn4TTNAL'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID. You can call the [ListSites](~~2850189~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], ], [ 'name' => 'Url', 'in' => 'query', - 'schema' => [ - 'description' => 'The OSS URL of the file that contains resources to be purged or prefetched.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'https://xxxxx.oss-cn-shenzhen.aliyuncs.com/test_oss_file?Expires=1708659191&OSSAccessKeyId=**********&Signature=**********', - 'isFileTransferUrl' => true, - 'title' => '', - ], + 'schema' => ['description' => 'The URL of the refresh or prefetch file stored in OSS. The Url parameter accepts URLs in two formats:'."\n" + ."\n" + .'- Transit URL (recommended): automatically generated through the file transfer feature of the ESA console or SDK.'."\n" + ."\n" + .'- OSS pre-signed HTTPS URL: generated after you upload the file to an authorized OSS bucket. The isFileTransferUrl field specifies whether to use the transit URL mode.', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => 'https://XXXXXX.oss-cn-hangzhou.aliyuncs.com/{prefix}_{account_uid}_{hash}', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the purge or prefetch task. Valid values:'."\n" - ."\n" - .'* **file** (default): purges the cache by file.'."\n" - .'* **preload**: prefetches the file.'."\n" - .'* **directory**: purges the cache by directory.'."\n" - .'* **ignoreParams**: purges the cache by URL with specified parameters ignored.'."\n", + 'description' => 'The type of the refresh or prefetch task. Valid values:'."\n" + .'- **file** (default): file refresh.'."\n" + .'- **preload**: file prefetch.'."\n" + .'- **directory**: directory refresh.'."\n" + .'- **ignoreParams**: parameter-ignored refresh.', + 'enumValueTitles' => ['file' => 'File refresh.', 'ignoreparams' => 'Parameter-ignored refresh.', 'preload' => 'File prefetch.', 'directory' => 'Directory refresh.'], 'type' => 'string', 'required' => true, + 'enum' => ['file', 'preload', 'directory', 'ignoreparams'], 'example' => 'file', - 'enum' => [ - 'file', - 'preload', - 'directory', - 'ignoreparams', - ], 'title' => '', ], ], @@ -96264,36 +53944,18 @@ 'name' => 'UploadTaskName', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The name of the upload task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'purge_task_2024_11_11', - 'maxLength' => 128, - 'title' => '', - ], + 'schema' => ['description' => 'The name of the upload task.', 'type' => 'string', 'required' => true, 'maxLength' => 128, 'example' => 'purge_task_2024_11_11', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F', - ], - 'UploadId' => [ - 'description' => 'The ID of the file upload task. You can use this ID for task submission or query subsequently.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '159253299357****', - 'title' => '', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F'], + 'UploadId' => ['description' => 'The ID of the file upload task. You can use this ID to submit or query the task.', 'type' => 'integer', 'format' => 'int64', 'example' => '159253299357****', 'title' => ''], ], 'example' => '', ], @@ -96301,82 +53963,33 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidTime', - 'errorMessage' => 'The query time cannot exceed the last 3 days.', - 'description' => 'The query time cannot exceed the last 3 days.', - ], - [ - 'errorCode' => 'MissingParameter.ObjectType', - 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', - 'description' => 'Specify the ObjectType parameter.', - ], - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The specified parameters are invalid.', - 'description' => 'Parameter is illegal.', - ], - [ - 'errorCode' => 'ExceedFileUpload', - 'errorMessage' => 'The size of the uploaded file exceeds the upper limit. Select a file less than 10 MB.', - 'description' => 'The size of the uploaded file exceeds the upper limit. Select a file less than 10 MB.', - ], - [ - 'errorCode' => 'TooManyRequests', - 'errorMessage' => 'Too many requests.Please try again later.', - 'description' => 'Requests are too frequent, please try again later.', - ], + ['errorCode' => 'InvalidTime', 'errorMessage' => 'The query time cannot exceed the last 3 days.', 'description' => 'The query time cannot exceed the last 3 days.'], + ['errorCode' => 'MissingParameter.ObjectType', 'errorMessage' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', 'description' => 'Specify the ObjectType parameter.'], + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The specified parameters are invalid.', 'description' => 'Parameter is illegal.'], + ['errorCode' => 'ExceedFileUpload', 'errorMessage' => 'The size of the uploaded file exceeds the upper limit. Select a file less than 10 MB.', 'description' => 'The size of the uploaded file exceeds the upper limit. Select a file less than 10 MB.'], + ['errorCode' => 'TooManyRequests', 'errorMessage' => 'Too many requests.Please try again later.', 'description' => 'Requests are too frequent, please try again later.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F\\",\\n \\"UploadId\\": 0\\n}","type":"json"}]', - 'title' => 'UploadFile', + 'title' => 'Upload a refresh or prefetch file', 'description' => '> '."\n" - ."\n" - .'* The file can be up to 10 MB in size.', + .'> - The maximum file size is 10 MB.', '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}', - ], - ], - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadFile'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], + 'ramActions' => [], ], 'UploadOriginCaCertificate' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -96389,123 +54002,44 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '261740', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890***', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. You can call the [ListSites](~~ListSites~~) operation to get this ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890***', 'title' => ''], ], [ 'name' => 'Certificate', 'in' => 'formData', - 'schema' => [ - 'description' => 'The certificate content.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '-----BEGIN CERTIFICATE-----', - 'title' => '', - ], + 'schema' => ['description' => 'The content of the CA certificate.', 'type' => 'string', 'required' => true, 'example' => '-----BEGIN CERTIFICATE-----', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The certificate name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'example', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the certificate.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n", - 'title' => '', - ], - 'Id' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'example' => 'babaabcd****', - 'title' => '', - ], - 'Status' => [ - 'description' => 'Indicates whether the operation is successful.'."\n" - ."\n" - .'* OK'."\n" - .'* Fail'."\n", - 'type' => 'string', - 'example' => 'OK', - 'title' => '', - ], - 'CommonName' => [ - 'description' => 'The Common Name of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com ', - 'title' => '', - ], - 'NotBefore' => [ - 'description' => 'The time when the certificate takes effect.'."\n", - 'type' => 'string', - 'example' => '2023-12-01T02:13:07Z', - 'title' => '', - ], - 'NotAfter' => [ - 'description' => 'The time when the certificate expires.'."\n", - 'type' => 'string', - 'example' => '2024-12-01T02:13:07Z', - 'title' => '', - ], - 'Issuer' => [ - 'description' => 'The CA that issued the certificate.'."\n", - 'type' => 'string', - 'example' => 'GlobalSign nv-sa', - 'title' => '', - ], - 'SerialNumber' => [ - 'description' => 'The serial number of the certificate.'."\n", - 'type' => 'string', - 'example' => 'babaded901474b9693acf530e0fb1daa', - 'title' => '', - ], - 'FingerprintSha256' => [ - 'description' => 'The SHA-256 fingerprint of the certificate.'."\n", - 'type' => 'string', - 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66', - 'title' => '', - ], - 'SignatureAlgorithm' => [ - 'description' => 'The signature algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'SHA256-RSA', - 'title' => '', - ], - 'ValidityDays' => [ - 'description' => 'The validity period of the certificate. Unit: day.'."\n", - 'type' => 'string', - 'example' => '365', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEBE525-F576-1196-8DAF-2D70CA3F4D2F'."\n", 'title' => ''], + 'Id' => ['description' => 'The certificate ID.', 'type' => 'string', 'example' => 'babaabcd****', 'title' => ''], + 'Status' => ['description' => 'The certificate status.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'CommonName' => ['description' => 'The common name of the certificate.', 'type' => 'string', 'example' => 'www.example.com ', 'title' => ''], + 'NotBefore' => ['description' => 'The validity start time of the certificate.', 'type' => 'string', 'example' => '2023-12-01T02:13:07Z', 'title' => ''], + 'NotAfter' => ['description' => 'The validity end time of the certificate.', 'type' => 'string', 'example' => '2024-12-01T02:13:07Z', 'title' => ''], + 'Issuer' => ['description' => 'The issuer of the certificate.', 'type' => 'string', 'example' => 'GlobalSign nv-sa', 'title' => ''], + 'SerialNumber' => ['description' => 'The serial number of the certificate.', 'type' => 'string', 'example' => 'babaded901474b9693acf530e0fb1daa', 'title' => ''], + 'FingerprintSha256' => ['description' => 'The SHA-256 fingerprint of the certificate.', 'type' => 'string', 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66', 'title' => ''], + 'SignatureAlgorithm' => ['description' => 'The signature algorithm of the certificate.', 'type' => 'string', 'example' => 'SHA256-RSA', 'title' => ''], + 'ValidityDays' => ['description' => 'The validity period of the certificate in days.', 'type' => 'string', 'example' => '365', 'title' => ''], ], 'example' => '', ], @@ -96513,65 +54047,26 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Certificate.StatusError', - 'errorMessage' => 'The status of the certificate is invalid.', - 'description' => 'The specified certificate status is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.Function', - 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', - 'description' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], + ['errorCode' => 'Certificate.StatusError', 'errorMessage' => 'The status of the certificate is invalid.', 'description' => 'The specified certificate status is invalid.'], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'QuotaCheckFailed.Function', 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', 'description' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Upload Origin Server CA Certificate', - 'summary' => 'Upload the origin server CA certificate.', - 'description' => 'You can add multiple origin servers under a source address. Origin servers of types such as domain name, IP address, OSS, and S3 are supported. Origin fetch authentication is supported for OSS and S3 origin servers.', + 'summary' => 'Uploads an origin server CA certificate.', + 'description' => 'You can add multiple origins to a site. Edge Security Acceleration (ESA) supports various origin types, including domain names, IP addresses, OSS, and S3. Origin authentication is supported for OSS or S3 origins.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '20', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UploadOriginCaCertificate', - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadOriginCaCertificate'], ], ], 'ramActions' => [ @@ -96582,12 +54077,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -96595,12 +54085,8 @@ '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', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -96613,131 +54099,49 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '261751', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'The site ID. To get this ID, call the [ListSites](~~2850189~~) API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], ], [ 'name' => 'Certificate', 'in' => 'formData', - 'schema' => [ - 'description' => 'The certificate content.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '-----BEGIN CERTIFICATE-----', - 'title' => '', - ], + 'schema' => ['description' => 'The content of the certificate in PEM format.', 'type' => 'string', 'required' => true, 'example' => '-----BEGIN CERTIFICATE-----', 'title' => ''], ], [ 'name' => 'PrivateKey', 'in' => 'formData', - 'schema' => [ - 'description' => 'The private key of the certificate.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '-----BEGIN PRIVATE KEY-----', - 'title' => '', - ], + 'schema' => ['description' => 'The private key for the certificate in PEM format.', 'type' => 'string', 'required' => true, 'example' => '-----BEGIN PRIVATE KEY-----', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The certificate name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - 'title' => '', - ], + 'schema' => ['description' => 'The certificate name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', - 'title' => '', - ], - 'Id' => [ - 'description' => 'The certificate ID.'."\n", - 'type' => 'string', - 'example' => 'babaabcd****', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the certificate.'."\n", - 'type' => 'string', - 'example' => 'OK', - 'title' => '', - ], - 'CommonName' => [ - 'description' => 'The Common Name of the certificate.'."\n", - 'type' => 'string', - 'example' => 'www.example.com', - 'title' => '', - ], - 'NotBefore' => [ - 'description' => 'The time when the certificate takes effect.'."\n", - 'type' => 'string', - 'example' => '2023-12-01T02:13:07Z', - 'title' => '', - ], - 'NotAfter' => [ - 'description' => 'The time when the certificate expires.'."\n", - 'type' => 'string', - 'example' => '2024-12-01T02:13:07Z', - 'title' => '', - ], - 'Issuer' => [ - 'description' => 'The CA that issued the certificate.'."\n", - 'type' => 'string', - 'example' => 'GlobalSign nv-sa', - 'title' => '', - ], - 'SerialNumber' => [ - 'description' => 'The serial number of the certificate.'."\n", - 'type' => 'string', - 'example' => 'babaded901474b9693acf530e0fb1daa', - 'title' => '', - ], - 'FingerprintSha256' => [ - 'description' => 'The SHA-256 fingerprint of the certificate.'."\n", - 'type' => 'string', - 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66', - 'title' => '', - ], - 'SignatureAlgorithm' => [ - 'description' => 'The signature algorithm of the certificate.'."\n", - 'type' => 'string', - 'example' => 'SHA256-RSA', - 'title' => '', - ], - 'ValidityDays' => [ - 'description' => 'The validity period of the certificate. Unit: day.'."\n", - 'type' => 'string', - 'example' => '365', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '36af3fcc-43d0-441c-86b1-428951dc8225', 'title' => ''], + 'Id' => ['description' => 'The ID of the certificate.', 'type' => 'string', 'example' => 'babaabcd****', 'title' => ''], + 'Status' => ['description' => 'The status of the certificate.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'CommonName' => ['description' => 'The common name of the certificate.', 'type' => 'string', 'example' => 'www.example.com', 'title' => ''], + 'NotBefore' => ['description' => 'The start of the certificate\'s validity period (`not before`). The timestamp is in UTC and formatted in ISO 8601.', 'type' => 'string', 'example' => '2023-12-01T02:13:07Z', 'title' => ''], + 'NotAfter' => ['description' => 'The end of the certificate\'s validity period (`not after`). The timestamp is in UTC and formatted in ISO 8601.', 'type' => 'string', 'example' => '2024-12-01T02:13:07Z', 'title' => ''], + 'Issuer' => ['description' => 'The issuer of the certificate.', 'type' => 'string', 'example' => 'GlobalSign nv-sa', 'title' => ''], + 'SerialNumber' => ['description' => 'The serial number of the certificate.', 'type' => 'string', 'example' => 'babaded901474b9693acf530e0fb1daa', 'title' => ''], + 'FingerprintSha256' => ['description' => 'The SHA-256 fingerprint of the certificate.', 'type' => 'string', 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66', 'title' => ''], + 'SignatureAlgorithm' => ['description' => 'The signature algorithm of the certificate.', 'type' => 'string', 'example' => 'SHA256-RSA', 'title' => ''], + 'ValidityDays' => ['description' => 'The validity period of the certificate in days.', 'type' => 'string', 'example' => '365', 'title' => ''], ], 'example' => '', ], @@ -96745,66 +54149,25 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Certificate.StatusError', - 'errorMessage' => 'The status of the certificate is invalid.', - 'description' => 'The specified certificate status is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.Function', - 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', - 'description' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'CertificateNotMatchPrivateKey', - 'errorMessage' => 'The specified certificate does not match the private key.', - 'description' => 'The specified certificate and private key do not match.', - ], + ['errorCode' => 'Certificate.StatusError', 'errorMessage' => 'The status of the certificate is invalid.', 'description' => 'The specified certificate status is invalid.'], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'QuotaCheckFailed.Function', 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', 'description' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'CertificateNotMatchPrivateKey', 'errorMessage' => 'The specified certificate does not match the private key.', 'description' => 'The specified certificate and private key do not match.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], ], 'title' => 'Upload a domain-granularity origin fetch client certificate.', - 'summary' => 'Upload a domain-granularity origin fetch client certificate.', + 'summary' => 'Uploads an origin client certificate for a site.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '20', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UploadOriginClientCertificate', - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadOriginClientCertificate'], ], ], 'ramActions' => [ @@ -96815,12 +54178,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -96829,12 +54187,8 @@ ], 'UploadSiteOriginClientCertificate' => [ 'summary' => 'Upload site origin client certificate', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -96847,56 +54201,29 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '261744', - 'abilityTreeNodes' => [ - 'FEATUREdcdnX7NWEB', - ], + 'abilityTreeNodes' => ['FEATUREdcdnX7NWEB'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Site ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456789****', - 'title' => '', - ], + 'schema' => ['description' => 'Site ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456789****', 'title' => ''], ], [ 'name' => 'Certificate', 'in' => 'formData', - 'schema' => [ - 'description' => 'The certificate content.', - 'type' => 'string', - 'required' => true, - 'example' => '-----BEGIN CERTIFICATE-----', - 'title' => '', - ], + 'schema' => ['description' => 'The certificate content.', 'type' => 'string', 'required' => true, 'example' => '-----BEGIN CERTIFICATE-----', 'title' => ''], ], [ 'name' => 'PrivateKey', 'in' => 'formData', - 'schema' => [ - 'description' => 'The private key of the certificate.', - 'type' => 'string', - 'required' => true, - 'example' => '-----BEGIN PRIVATE KEY-----', - 'title' => '', - ], + 'schema' => ['description' => 'The private key of the certificate.', 'type' => 'string', 'required' => true, 'example' => '-----BEGIN PRIVATE KEY-----', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The certificate name.', - 'type' => 'string', - 'required' => false, - 'example' => 'example', - 'title' => '', - ], + 'schema' => ['description' => 'The certificate name.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], ], ], 'responses' => [ @@ -96906,72 +54233,17 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - 'title' => '', - ], - 'Id' => [ - 'description' => 'The certificate ID on ESA.', - 'type' => 'string', - 'example' => 'babaabcd****', - 'title' => '', - ], - 'Status' => [ - 'description' => 'The status of the certificate.', - 'type' => 'string', - 'example' => 'OK', - 'title' => '', - ], - 'CommonName' => [ - 'description' => 'The Common Name of the certificate.', - 'type' => 'string', - 'example' => 'www.example.com', - 'title' => '', - ], - 'NotBefore' => [ - 'description' => 'The time when the certificate takes effect.', - 'type' => 'string', - 'example' => '2023-12-01T02:13:07Z', - 'title' => '', - ], - 'NotAfter' => [ - 'description' => 'The time when the certificate expires.', - 'type' => 'string', - 'example' => '2024-12-01T02:12:49Z', - 'title' => '', - ], - 'Issuer' => [ - 'description' => 'The CA that issued the certificate.', - 'type' => 'string', - 'example' => 'GlobalSign nv-sa', - 'title' => '', - ], - 'SerialNumber' => [ - 'description' => 'The serial number of the certificate.', - 'type' => 'string', - 'example' => 'babaded901474b9693acf530e0fb1d**', - 'title' => '', - ], - 'FingerprintSha256' => [ - 'description' => 'The SHA-256 fingerprint of the certificate.', - 'type' => 'string', - 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca**', - 'title' => '', - ], - 'SignatureAlgorithm' => [ - 'description' => 'The signature algorithm of the certificate.', - 'type' => 'string', - 'example' => 'SHA256-RSA', - 'title' => '', - ], - 'ValidityDays' => [ - 'description' => 'The validity period of the certificate. Unit: day.', - 'type' => 'string', - 'example' => '365', - 'title' => '', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', 'title' => ''], + 'Id' => ['description' => 'The certificate ID on ESA.', 'type' => 'string', 'example' => 'babaabcd****', 'title' => ''], + 'Status' => ['description' => 'The status of the certificate.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'CommonName' => ['description' => 'The Common Name of the certificate.', 'type' => 'string', 'example' => 'www.example.com', 'title' => ''], + 'NotBefore' => ['description' => 'The time when the certificate takes effect.', 'type' => 'string', 'example' => '2023-12-01T02:13:07Z', 'title' => ''], + 'NotAfter' => ['description' => 'The time when the certificate expires.', 'type' => 'string', 'example' => '2024-12-01T02:12:49Z', 'title' => ''], + 'Issuer' => ['description' => 'The CA that issued the certificate.', 'type' => 'string', 'example' => 'GlobalSign nv-sa', 'title' => ''], + 'SerialNumber' => ['description' => 'The serial number of the certificate.', 'type' => 'string', 'example' => 'babaded901474b9693acf530e0fb1d**', 'title' => ''], + 'FingerprintSha256' => ['description' => 'The SHA-256 fingerprint of the certificate.', 'type' => 'string', 'example' => '1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca**', 'title' => ''], + 'SignatureAlgorithm' => ['description' => 'The signature algorithm of the certificate.', 'type' => 'string', 'example' => 'SHA256-RSA', 'title' => ''], + 'ValidityDays' => ['description' => 'The validity period of the certificate. Unit: day.', 'type' => 'string', 'example' => '365', 'title' => ''], ], 'example' => '', ], @@ -96979,53 +54251,17 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Certificate.StatusError', - 'errorMessage' => 'The status of the certificate is invalid.', - 'description' => 'The specified certificate status is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.SiteId', - 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', - ], - [ - 'errorCode' => 'MissingSiteId', - 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'errorCode' => 'QuotaCheckFailed.Function', - 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', - 'description' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', - ], - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'CertificateNotMatchPrivateKey', - 'errorMessage' => 'The specified certificate does not match the private key.', - 'description' => 'The specified certificate and private key do not match.', - ], + ['errorCode' => 'Certificate.StatusError', 'errorMessage' => 'The status of the certificate is invalid.', 'description' => 'The specified certificate status is invalid.'], + ['errorCode' => 'InvalidParameter.SiteId', 'errorMessage' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', 'description' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], + ['errorCode' => 'MissingSiteId', 'errorMessage' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['errorCode' => 'QuotaCheckFailed.Function', 'errorMessage' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', 'description' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.'], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'CertificateNotMatchPrivateKey', 'errorMessage' => 'The specified certificate does not match the private key.', 'description' => 'The specified certificate and private key do not match.'], ], 403 => [ - [ - 'errorCode' => 'Unauthorized.InvalidTime', - 'errorMessage' => 'The specified authentication time is invalid.', - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'errorCode' => 'Unauthorized.InvalidToken', - 'errorMessage' => 'Token authentication failed.', - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], + ['errorCode' => 'Unauthorized.InvalidTime', 'errorMessage' => 'The specified authentication time is invalid.', 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['errorCode' => 'Unauthorized.InvalidToken', 'errorMessage' => 'Token authentication failed.', 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], ], ], '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"}]', @@ -97033,12 +54269,7 @@ 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '20', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'UploadSiteOriginClientCertificate', - ], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadSiteOriginClientCertificate'], ], ], 'ramActions' => [ @@ -97049,25 +54280,15 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], ], ], 'VerifyCustomHostname' => [ - 'summary' => 'Verifies the ownership of a Software as a Service (SaaS) domain name. After a domain name is verified, the site is automatically activated.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -97080,23 +54301,14 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239650', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4DMKZ4', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4DMKZ4'], ], 'parameters' => [ [ 'name' => 'HostnameId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The ID of the SaaS domain name. You can call the [ListCustomHostnames](~~3018667~~) operation to obtain the ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'title' => '', - 'example' => '1234567890123', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the SaaS domain name. You can call the [ListCustomHostnames](~~3018667~~) operation to obtain the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123'], ], ], 'responses' => [ @@ -97104,18 +54316,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request. This is a unique identifier generated by Alibaba Cloud for the request.', - 'type' => 'string', - 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', - 'title' => '', - ], - 'Passed' => [ - 'description' => 'Indicates whether the verification passed.', - 'type' => 'boolean', - 'title' => '', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID. A unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => '0AEDAF20-4DDF-4165-8750-47FF9C1929C9', 'title' => ''], + 'Passed' => ['title' => '', 'description' => 'Indicates whether the verification is passed.', 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', 'title' => '', @@ -97125,77 +54327,54 @@ ], 'errorCodes' => [ 200 => [ - [ - 'errorCode' => 'CustomHostname.VerifyUnpassed', - 'errorMessage' => 'The custom hostname ownership verification failed. Complete the verification and try again.', - 'description' => 'The custom hostname ownership verification failed. Complete the verification and try again.', - ], + ['errorCode' => 'CustomHostname.VerifyUnpassed', 'errorMessage' => 'The custom hostname ownership verification failed. Complete the verification and try again.', 'description' => 'The custom hostname ownership verification failed. Complete the verification and try again.'], ], 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - 'description' => 'The specified parameter is invalid.', - ], - [ - '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' => '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.', - ], - [ - 'errorCode' => 'Instance.NotOnline', - 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'errorCode' => 'Record.ServiceBusy', - 'errorMessage' => 'The record is being configured. Try again later.', - 'description' => 'The record is being configured. Try again later.', - ], - [ - '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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.', - ], - [ - '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' => 'The custom hostname conflicts with existing resources, such as sites, records, load balancers, source address pools, custom hostnames and Layer 4 proxy records.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['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' => '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.'], + ['errorCode' => 'Instance.NotOnline', 'errorMessage' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['errorCode' => 'Record.ServiceBusy', 'errorMessage' => 'The record is being configured. Try again later.', 'description' => 'The record is being configured. Try again later.'], + ['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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.'], + ['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' => 'The custom hostname conflicts with existing resources, such as sites, records, load balancers, source address pools, custom hostnames and Layer 4 proxy records.'], + ['errorCode' => 'CustomHostname.OfflineForMultiReason', 'errorMessage' => 'Unable to activate the custom hostname because it is offline due to multiple reasons.', 'description' => ''], + ['errorCode' => 'CustomHostname.InvalidStatus', 'errorMessage' => 'The status of the custom hostname you configured is invalid, and this operation cannot be performed. Please check the status of the custom hostname and try again.', 'description' => 'The status of the custom hostname you configured is invalid, and this operation cannot be performed. Please check the status of the custom hostname and try again.'], ], 404 => [ - [ - 'errorCode' => 'CustomHostname.NotFound', - 'errorMessage' => 'The custom hostname does not exist. Modify it and try again.', - 'description' => 'The custom hostname does not exist. Modify it and try again.', - ], + ['errorCode' => 'CustomHostname.NotFound', 'errorMessage' => 'The custom hostname does not exist. Modify it and try again.', 'description' => 'The custom hostname does not exist. Modify it and try again.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'title' => 'VerifyCustomHostname', + 'title' => 'Verify saaS domain name ownership', + 'summary' => 'Verifies the ownership of a SaaS domain name. Sites that pass the verification are automatically activated.', 'changeSet' => [], 'flowControl' => [ - 'flowControlList' => [], + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyCustomHostname'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'esa:VerifyCustomHostname', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0AEDAF20-4DDF-4165-8750-47FF9C1929C9\\",\\n \\"Passed\\": true\\n}","type":"json"}]', ], 'VerifySite' => [ 'summary' => 'Verifies the ownership of a website domain. Websites that pass the verification are automatically activated.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -97208,22 +54387,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '239614', - 'abilityTreeNodes' => [ - 'FEATUREdcdn4W8FYZ', - ], + 'abilityTreeNodes' => ['FEATUREdcdn4W8FYZ'], ], 'parameters' => [ [ 'name' => 'SiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234567890123', - 'title' => '', - ], + 'schema' => ['description' => 'The website ID, which can be obtained by calling the [ListSites](~~2850189~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234567890123', 'title' => ''], ], ], 'responses' => [ @@ -97231,21 +54401,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '65C66B7B-671A-8297-9187-2R5477247B76', - 'title' => '', - ], - 'Passed' => [ - 'description' => 'Indicates whether the verification passed. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '65C66B7B-671A-8297-9187-2R5477247B76', 'title' => ''], + 'Passed' => ['description' => 'Indicates whether the verification passed. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', @@ -97255,49 +54415,23 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InternalException', - 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'errorCode' => 'Site.ServiceBusy', - 'errorMessage' => 'This website is being configured. Try again later.', - 'description' => 'This website is being configured. Try again later.', - ], - [ - 'errorCode' => 'Site.Conflict', - 'errorMessage' => 'Duplicate website names exist across multiple accounts. Rename or delete one and try again.', - 'description' => 'Duplicate website names exist across multiple accounts. Rename or delete one and try again.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', - 'description' => 'Invalid parameter. Check the parameter configuration.', - ], + ['errorCode' => 'InternalException', 'errorMessage' => 'Failed to call the service. Try again later or contact technical support.', 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['errorCode' => 'Site.ServiceBusy', 'errorMessage' => 'This website is being configured. Try again later.', 'description' => 'This website is being configured. Try again later.'], + ['errorCode' => 'Site.Conflict', 'errorMessage' => 'Duplicate website names exist across multiple accounts. Rename or delete one and try again.', 'description' => 'Duplicate website names exist across multiple accounts. Rename or delete one and try again.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter. Check the parameter configuration.', 'description' => 'Invalid parameter. Check the parameter configuration.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"65C66B7B-671A-8297-9187-2R5477247B76\\",\\n \\"Passed\\": true\\n}","type":"json"}]', 'title' => 'VerifySite', 'description' => '1. For a website connected by using NS setup, this operation verifies whether the nameservers of the website are the nameservers assigned by Alibaba Cloud.'."\n" .'2. For a website connected by using CNAME setup, this operation verifies whether the website has a TXT record whose hostname is _esaauth.[websiteDomainName] and record value is the value of VerifyCode to the DNS records of your domain. You can see the VerifyCode field in the site information.', 'changeSet' => [ - [ - 'createdAt' => '2024-09-18T06:13:38.000Z', - 'description' => 'Error codes changed', - ], + ['createdAt' => '2024-09-18T06:13:38.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ - [ - 'threshold' => '30', - 'countWindow' => 1, - 'regionId' => '*', - 'api' => 'VerifySite', - ], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifySite'], ], ], 'ramActions' => [ @@ -97308,12 +54442,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'Site', - 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}', - ], + ['validationType' => 'always', 'product' => 'ESA', 'resourceType' => 'Site', 'arn' => 'acs:esa:{#regionId}:{#accountId}:site/{#SiteId}'], ], ], ], @@ -97325,13843 +54454,1744 @@ ], ], 'endpoints' => [ - [ - 'regionId' => 'ap-southeast-1', - 'regionName' => 'Singapore', - 'areaId' => 'asiaPacific', - 'areaName' => 'Asia Pacific', - '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' => 'China (Hangzhou)', - 'areaId' => 'asiaPacific', - 'areaName' => 'Asia Pacific', - 'public' => 'esa.cn-hangzhou.aliyuncs.com', - 'endpoint' => 'esa.cn-hangzhou.aliyuncs.com', - 'vpc' => 'esa-vpc.cn-hangzhou.aliyuncs.com', - ], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'The specified resource type is not supported. To use this type of resource, please contact us.'], + ['code' => '%s.OverQuota', 'message' => 'The quantity of %s exceeds the quota.', 'http_code' => 403, 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.'], + ['code' => '%s.WrongValueMatched', 'message' => 'The value of specified parameter %s can not pass the matching check.', 'http_code' => 403, 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.'], + ['code' => 'AccountBlacklist', 'message' => 'Account blacklist restrictions, please submit a work order to contact customer service for processing.', 'http_code' => 400, 'description' => 'Account blacklist restrictions, please submit a work order to contact customer service for processing.'], + ['code' => 'AccountStatusIllegal', 'message' => 'The account status is illegal.', 'http_code' => 400, 'description' => 'The account status is illegal.'], + ['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' => 'Failed to match an active website based on the hostname you specified. Check whether the hostname is correct or activate the website first.'], + ['code' => 'AppAlreadyExist', 'message' => 'The containerized application name already exists. Specify another name.', 'http_code' => 400, 'description' => 'The containerized application name already exists. Specify another name.'], + ['code' => 'ApplyCertificateNotAllowed', 'message' => 'The certificate application is not allowed for current site.', 'http_code' => 400, 'description' => 'The current site is not allowed to request a free certificate, please make sure the site is activated. To apply for a wildcard domain name certificate, make sure that the current site is accessed in NS mode.'], + ['code' => 'ApplyVanityNSError', 'message' => 'Failed to apply for vanity NS resources. Please contact customer service.', 'http_code' => 400, 'description' => 'Failed to apply for vanity NS resources. Please contact customer service.'], + ['code' => 'ApplyVipError', 'message' => 'Failed to apply for ip resources, please contact customer service.', 'http_code' => 400, 'description' => 'Failed to apply for IP resources, please contact customer service.'], + ['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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.'], + ['code' => 'BASIC_INFO_UNCOMPLETED', 'message' => 'You have not completed your personal basic information. Please complete the information and try again.', 'http_code' => 400, 'description' => 'You have not completed your basic personal information. Please complete the information and re-operate. (If the current account is a managed sub-account, please contact the main account and click this link to complete the information.) <"/>esarealtimelogpushsls.dcdnservices.aliyuncs.com<"/><"/>.', 'http_code' => 400, 'description' => 'You do not have permissions to create a service-linked role.Contact your account administrator to attach the AliyunESAFullAccess policy or a custom policy that grants permissions to create a service-linked role to the current user.Service: <"/><"/>esarealtimelogpushsls.dcdnservices.aliyuncs.com<"/><"/>.'], + ['code' => 'CreateTimeError', 'message' => 'The effective time of the same policy template cannot overlap.', 'http_code' => 400, 'description' => 'The effective time of the same policy template cannot overlap.'], + ['code' => 'DependedByOthers', 'message' => 'Failed to call the service. Try again later or contact technical support.', 'http_code' => 400, 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['code' => 'DnsSecDenied', 'message' => 'Only sites accessed by NS can enable DNSSEC.', 'http_code' => 400, 'description' => 'Only sites accessed by NS can enable the DNSSEC function.'], + ['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' => '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.'], + ['code' => 'DomainInRiskList', 'message' => 'The domain you added may be at risk. If you have any questions, please submit a ticket.', 'http_code' => 400, 'description' => 'The domain name you added may be at risk. If you have any questions, please submit a work order.'], + ['code' => 'DomainNameOverLimit', 'message' => 'A maximum of 500 domains are supported for each request.', 'http_code' => 400, 'description' => 'Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.'], + ['code' => 'DuplicateRequirementTicket', 'message' => 'Repeated demand order.', 'http_code' => 400, 'description' => 'Repeated demand order.'], + ['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' => 'There is overlap between multiple edge ports, please check and try again after modification.'], + ['code' => 'EnterpriseAmountErr', 'message' => 'Enterprise plans do not support bulk purchase.', 'http_code' => 400, 'description' => 'Enterprise plans do not support bulk purchase.'], + ['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' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.'], + ['code' => 'ErService.HasOpened', 'message' => 'You have already activated Edge Routine.', 'http_code' => 400, 'description' => 'You have already activated Edge Routine.'], + ['code' => 'ErService.NotOpen', 'message' => 'Er service has not opend.', 'http_code' => 403, 'description' => 'Er service has not opend.'], + ['code' => 'EsaService.NotOpen', 'message' => 'ESA service has not opend.', 'http_code' => 403, 'description' => 'Edge Security Accelerator (ESA) is not turned on'], + ['code' => 'ExceedFileUpload', 'message' => 'The size of the uploaded file exceeds the upper limit. Select a file less than 10 MB.', 'http_code' => 400, 'description' => 'The size of the uploaded file exceeds the upper limit. Select a file less than 10 MB.'], + ['code' => 'Expression.Invalid', 'message' => 'Expression syntax error or data type mismatched.', 'http_code' => 403, 'description' => 'Expression syntax error or data type mismatched.'], + ['code' => 'Expression.Invalid', 'message' => 'The specified expression is invalid: %s.', 'http_code' => 403, 'description' => 'The specified expression is invalid.'], + ['code' => 'Forbidden', 'message' => 'You are not authorized to operate this resource, or this API does not support RAM.', 'http_code' => 403, 'description' => 'You are not authorized to operate this resource, or this API does not support RAM.'], + ['code' => 'FunctionConflict', 'message' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', 'http_code' => 400, 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.'], + ['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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.'], + ['code' => 'HostnameNumberExceedLimit', 'message' => 'The maximum number of hostnames associated with the CA certificate you specified has been reached.', 'http_code' => 400, 'description' => 'The number of domain names bound to CA certificates exceeds the limit. A maximum of 50 domain names can be bound to each CA certificate.'], + ['code' => 'Id.MissingParameter', 'message' => 'The parameter Id is required.', 'http_code' => 400, 'description' => 'The required parameter Id is missing.'], + ['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' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.'], + ['code' => 'Instance.NotOnline', 'message' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', 'http_code' => 400, 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.'], + ['code' => 'Instance.ReleaseFailed', 'message' => 'Instance release failed.', 'http_code' => 400, 'description' => 'Instance release failed.'], + ['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' => 'The security instance can only be changed after 31 days of purchase, and can only be changed once a natural month.'], + ['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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.'], + ['code' => 'InsufficientAvailableQuota', 'message' => 'Your account balance is insufficient.', 'http_code' => 400, 'description' => 'Your account is in arrears, please pay the arrears before purchasing.'], + ['code' => 'InsufficientBalance', 'message' => 'Your account balance is insufficient.', 'http_code' => 400, 'description' => 'Your account balance is insufficient, please recharge before purchasing.'], + ['code' => 'InternalError', 'message' => 'An internal exception occurred, please try again later.', 'http_code' => 400, 'description' => 'An inner exception was triggered. Please try again later.'], + ['code' => 'InternalError', 'message' => 'Failed to call the service. Try again later or contact technical support.', 'http_code' => 500, 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['code' => 'InternalException', 'message' => 'Failed to call the service. Try again later or contact technical support.', 'http_code' => 400, 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['code' => 'InternalOperationError', 'message' => 'Failed to call the service. Try again later or contact technical support.', 'http_code' => 400, 'description' => 'Failed to call the service. Try again later or contact technical support.'], + ['code' => 'Invalid.Parameter', 'message' => 'Invalid request parameters for querying standard logs. Check and try again.', 'http_code' => 400, 'description' => 'Invalid request parameters for querying standard logs. Check and try again.'], + ['code' => 'Invalid.Value', 'message' => 'Invalid value in the key-value pair. Make sure the value is Base64-encoded.', 'http_code' => 400, 'description' => 'Invalid value in the key-value pair. Make sure the value is Base64-encoded.'], + ['code' => 'InvalidAccount.Malformed', 'message' => 'The specified account is invalid.', 'http_code' => 400, 'description' => 'The account number is not entered correctly, for example, the input is empty.'], + ['code' => 'InvalidAccount.NotFound', 'message' => 'The specified account does not exist.', 'http_code' => 404, 'description' => 'The specified account does not exist.'], + ['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' => 'The application does not exist. Check whether the application ID you specified is correct and try again.'], + ['code' => 'InvalidArgName', 'message' => 'The parameter name does not exist, please check the function interface document.', 'http_code' => 400, 'description' => 'The parameter name does not exist, please check the function interface document.'], + ['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' => 'The specified certificate does not match the website. Check the validity of the certificate and try again.'], + ['code' => 'InvalidComponent', 'message' => 'The order parameters is invalid.', 'http_code' => 400, 'description' => 'The order parameters is invalid.'], + ['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' => 'The ConfigId does not exist.'], + ['code' => 'InvalidEndTime.Malformed', 'message' => 'The specified EndTime is invalid.', 'http_code' => 400, 'description' => 'Please provide the correct end time format. The date format follows ISO8601 notation and uses UTC time. The format is: yyyy-MM-ddTHH:mm:ssZ.'], + ['code' => 'InvalidEndTime.Mismatch', 'message' => 'The specified EndTime is earlier than the StartTime.', 'http_code' => 400, 'description' => 'The end time you entered is earlier than the start time. Please check and try again.'], + ['code' => 'InvalidExecution.CountFull', 'message' => 'The maximum number of prefetch plans has been reached. Delete some completed tasks and try again.', 'http_code' => 400, 'description' => 'The maximum number of prefetch plans has been reached. Delete some completed tasks and try again.'], + ['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' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.'], + ['code' => 'InvalidFunctions.Malformed', 'message' => 'The specified Functions is invalid.', 'http_code' => 400, 'description' => 'The specified configuration is invalid.'], + ['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' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.'], + ['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' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.'], + ['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' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.'], + ['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' => 'The maximum storage capacity of the Edge KV namespace has been reached. Delete unwanted key-value pairs to save the storage.'], + ['code' => 'InvalidKey.ExceedsCapacity', 'message' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', 'http_code' => 403, 'description' => 'The capacity of the storage space exceeds the limit.'], + ['code' => 'InvalidKey.ExceedsMaximum', 'message' => 'The size of the key cannot exceed 512 bytes.', 'http_code' => 400, 'description' => 'The length of the requested key is too large.'], + ['code' => 'InvalidKey.Malformed', 'message' => 'The specified key is invalid.', 'http_code' => 400, 'description' => 'Key name input error, such as entering an empty string.'], + ['code' => 'InvalidKey.NotFound', 'message' => 'The specified key does not exist.', 'http_code' => 404, 'description' => 'The specified key-value pair does not exist.'], + ['code' => 'InvalidKey.QuotaFull', 'message' => 'The total number of IP exceeds the quota.', 'http_code' => 406, 'description' => 'The total number of ip addresses exceeds the quota.'], + ['code' => 'InvalidKey.TooManyDimensions', 'message' => 'Request contains too many dimensions.', 'http_code' => 400, 'description' => 'Request contains too many dimensions. For more information, see OpenAPI Documentation .'."\n"], + ['code' => 'InvalidNameSpace.Duplicate', 'message' => 'The specified namespace already exists.', 'http_code' => 406, 'description' => 'Specified storage space'], + ['code' => 'InvalidNameSpace.Malformed', 'message' => 'The specified namespace is invalid.', 'http_code' => 400, 'description' => 'The bucket name is entered incorrectly, such as an empty string.'], + ['code' => 'InvalidNameSpace.NotFound', 'message' => 'The specified namespace does not exist.', 'http_code' => 404, 'description' => 'The specified storage space does not exist.'], + ['code' => 'InvalidNameSpace.QuotaFull', 'message' => 'The maximum number of namespaces is exceeded.', 'http_code' => 406, 'description' => 'The number of storage spaces exceeds the capacity limit.'], + ['code' => 'InvalidNextToken', 'message' => 'The specified parameter NextToken is invalid.', 'http_code' => 400, 'description' => 'The parameter NextToken is illegal.'], + ['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' => 'The request PageSize value is invalid. The default value is 20 and the value range is 1-500.'], + ['code' => 'InvalidParameter', 'message' => 'Invalid parameter. Check the parameter configuration.', 'http_code' => 400, 'description' => 'Invalid parameter. Check the parameter configuration.'], + ['code' => 'InvalidParameter', 'message' => 'Parameter verification failed. Check your configurations and try again.', 'http_code' => 400, 'description' => 'Parameter verification failed. Check your configurations and try again.'], + ['code' => 'InvalidParameter', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => 'The specified parameter is invalid.'], + ['code' => 'InvalidParameter.AddressConflict', 'message' => 'Duplicate origin addresses. Make sure that each origin address for the same pool is unique.', 'http_code' => 400, 'description' => 'Duplicate origin addresses. Make sure that each origin address for the same pool is unique.'], + ['code' => 'InvalidParameter.ApiItems.Api', 'message' => 'The parameter apiItems api is invalid.', 'http_code' => 400, 'description' => 'The parameter apiItems api is invalid.'], + ['code' => 'InvalidParameter.ApiItems.Host', 'message' => 'The parameter apiItems host is invalid.', 'http_code' => 400, 'description' => 'The parameter apiItems host is invalid.'], + ['code' => 'InvalidParameter.ApiShield.Quota', 'message' => 'This website does not have the permission to view API security features.', 'http_code' => 400, 'description' => 'This website does not have the permission to view API security features.'], + ['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' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application 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' => 'The format of the input application ID is incorrect. You can use the ListEdgeContainerApps API to obtain the application 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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.'], + ['code' => 'InvalidParameter.ArgValue', 'message' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', 'http_code' => 400, 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.'], + ['code' => 'InvalidParameter.ClientIpPassThroughMode', 'message' => 'Invalid client IP transfer protocol, please refer to the interface document and pass in valid parameters.', 'http_code' => 400, 'description' => 'Invalid client IP transfer protocol, please refer to the interface document and pass in valid parameters.'], + ['code' => 'InvalidParameter.CnameSiteRecordNoProxied', 'message' => 'A non-proxied record was added for a website using a CNAME setup.', 'http_code' => 400, 'description' => 'A non-proxied record was added for a website using a CNAME setup.'], + ['code' => 'InvalidParameter.CnameSiteRecordUnsupport', 'message' => 'The current record type is not supported for a website connected by CNAME setup.', 'http_code' => 400, 'description' => 'You can only add A/AAAA and CNAME records to a website connected by CNAME setup.'], + ['code' => 'InvalidParameter.ConfigIds', 'message' => 'Invalid ConfigId. Specify an existing Configld and make sure it is in the valid format.', 'http_code' => 400, 'description' => 'Invalid ConfigId. Specify an existing Configld and make sure it is in the valid format.'], + ['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' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.'], + ['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' => 'The selected location is unavailable in your plan. Change the location to one that is covered by the plan and try again.'], + ['code' => 'InvalidParameter.Dimension', 'message' => 'The specified Dimension is invalid.', 'http_code' => 400, 'description' => 'The specified Dimension is invalid. For more information, see OpenAPI Documentation .'."\n"], + ['code' => 'InvalidParameter.DomainNotBelongingUser', 'message' => 'The domain name passed in does not belong to the current user.', 'http_code' => 400, 'description' => 'The domain name passed in does not belong to the current user.'], + ['code' => 'InvalidParameter.Domains', 'message' => 'Duplicate domain names are specified for parameter Domains. Remove one of them and try again.', 'http_code' => 400, 'description' => 'Duplicate domain names are specified for parameter Domains. Remove one of them and try again.'], + ['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' => 'The maximum number of domain names specified by parameter Domains has been reached. Adjust your configurations and try again.'], + ['code' => 'InvalidParameter.Domains', 'message' => 'You have already submitted a certificate application for the domain name.', 'http_code' => 400, 'description' => 'You have already submitted a certificate application for the domain name.'], + ['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' => 'One or more domain names specified by parameter Domains do not belong to the current website. Check and try again.'], + ['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 there is an invalid domain name in the parameter, please check and try again.'], + ['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' => 'The site you configured is currently accessed in the CNAME mode. Please switch to the NS mode and try again.'], + ['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' => '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.'], + ['code' => 'InvalidParameter.Domains', 'message' => 'The site which is configured in CNAME mode does not support wildcard domain certificate application.', 'http_code' => 400, 'description' => 'The CNAME site does not support applying for a free certificate for wildcard domain names.'], + ['code' => 'InvalidParameter.DomainsExceedLimit', 'message' => 'The number of incoming domain names exceeds the maximum limit.', 'http_code' => 400, 'description' => 'The number of incoming domain names exceeds the maximum limit.'."\n"], + ['code' => 'InvalidParameter.DomainSourceTypeNotSupport', 'message' => 'The underlying source type of the domain is not supported.', 'http_code' => 400, 'description' => 'The underlying origin type of the domain name is not supported.'], + ['code' => 'InvalidParameter.EmptyAKSK', 'message' => 'AK,SK information cannot be empty.', 'http_code' => 400, 'description' => 'AK,SK information cannot be empty.'], + ['code' => 'InvalidParameter.EndpointId', 'message' => 'The parameter EndpointId is invalid.', 'http_code' => 400, 'description' => 'The parameter EndpointId is invalid.'], + ['code' => 'InvalidParameter.ExistedHandlingTask', 'message' => 'There is a task in process, waiting for execution to complete.', 'http_code' => 400, 'description' => 'There is a task in process, waiting for execution to complete.'], + ['code' => 'InvalidParameter.Field', 'message' => 'The specified Field is invalid.', 'http_code' => 400, 'description' => 'The specified Field is invalid. For more information, see OpenAPI Documentation .'], + ['code' => 'InvalidParameter.FunctionName', 'message' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', 'http_code' => 400, 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.'], + ['code' => 'InvalidParameter.FuzzySearch', 'message' => 'The parameter fuzzySearch is invalid.', 'http_code' => 400, 'description' => 'The parameter fuzzySearch is invalid.'], + ['code' => 'InvalidParameter.HealthCheckFailTimes', 'message' => 'Specified parameter HealthCheckFailTimes is not valid.', 'http_code' => 400, 'description' => 'Parameter HealthCheckFailTimes format is incorrect.'], + ['code' => 'InvalidParameter.HealthCheckHost', 'message' => 'Specified parameter HealthCheckHost is not valid.', 'http_code' => 400, 'description' => 'Parameter HealthCheckHost format is incorrect.'], + ['code' => 'InvalidParameter.HealthCheckHttpCode', 'message' => 'Specified parameter HealthCheckHttpCode is not valid.', 'http_code' => 400, 'description' => 'Parameter HealthCheckHttpCode format is incorrect.'], + ['code' => 'InvalidParameter.HealthCheckInterval', 'message' => 'Specified parameter HealthCheckInterval is not valid.', 'http_code' => 400, 'description' => 'Parameter HealthCheckInterval format is incorrect.'], + ['code' => 'InvalidParameter.HealthCheckMethod', 'message' => 'Specified parameter HealthCheckMethod is not valid.', 'http_code' => 400, 'description' => 'Parameter HealthCheckMethod format is incorrect.'], + ['code' => 'InvalidParameter.HealthCheckPort', 'message' => 'Specified parameter HealthCheckPort is not valid.', 'http_code' => 400, 'description' => 'Parameter HealthCheckPort format is incorrect.'], + ['code' => 'InvalidParameter.HealthCheckSuccTimes', 'message' => 'Specified parameter HealthCheckSuccTimes is not valid.', 'http_code' => 400, 'description' => 'Parameter HealthCheckHost format is incorrect.'], + ['code' => 'InvalidParameter.HealthCheckTimeout', 'message' => 'Specified parameter HealthCheckTimeout is not valid.', 'http_code' => 400, 'description' => 'Parameter HealthCheckTimeout format is incorrect.'], + ['code' => 'InvalidParameter.HealthCheckType', 'message' => 'Specified parameter HealthCheckType is not valid.', 'http_code' => 400, 'description' => 'Parameter HealthCheckType format is incorrect.'], + ['code' => 'InvalidParameter.HealthCheckURI', 'message' => 'Specified parameter HealthCheckURI is not valid.', 'http_code' => 400, 'description' => 'Parameter HealthCheckURI format is incorrect.'], + ['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' => 'The HttpHeaders parameter is invalid. Please check whether the HttpHeaders parameter is filled in. The parameter cannot contain @.'], + ['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' => 'Illegal Image parameter. Please check the Image parameter, which cannot be assigned to illegal characters such @.'], + ['code' => 'InvalidParameter.InvalidBiz', 'message' => 'the value of the business type is empty or the incoming parameter is invalid.', 'http_code' => 400, 'description' => 'The value of the business type is empty or the incoming parameter is invalid.'], + ['code' => 'InvalidParameter.InvalidBiz', 'message' => 'The incoming parameter value of the business type is empty or incorrect.', 'http_code' => 400, 'description' => 'The incoming parameter value of the business type is empty or incorrect.'], + ['code' => 'InvalidParameter.InvalidDSRecordName', 'message' => 'Please add/import an NS record with the same name before adding this DS record.', 'http_code' => 400, 'description' => 'Please add/import an NS record with the same name before adding this DS record'], + ['code' => 'InvalidParameter.InvalidHostPolicy', 'message' => 'The host parameter in the origin fetch request is invalid.', 'http_code' => 400, 'description' => 'The host parameter in the origin fetch request is invalid.'], + ['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' => 'The record name you entered does not meet the specifications. Please adjust the record name according to the product documentation.'], + ['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' => 'The record name you entered does not meet the specifications. Please adjust the record name according to the product documentation.'], + ['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' => 'If you add another record, the suffix of the host record must be the same as the site name. Please adjust and try again.'], + ['code' => 'InvalidParameter.InvalidSiteEnvironmentName', 'message' => 'The specified site environment name is invalid.', 'http_code' => 400, 'description' => 'The specified site environment name is invalid.'], + ['code' => 'InvalidParameter.InvalidVanityNSName', 'message' => 'A vanity nameserver must be an absolute domain name. Correct it and try again.', 'http_code' => 400, 'description' => 'You need to enter the full domain name to customize the NS name. Please adjust and submit it again.'], + ['code' => 'InvalidParameter.InvalidVanityNSNum', 'message' => 'Enter 2 to 5 vanity nameservers. Correct them and try again.', 'http_code' => 400, 'description' => 'Custom NS requires 2~5 names, please adjust and resubmit.'], + ['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' => 'Invalid load balancer name. Make sure that you specify a valid subdomain name under your website domain for the load balancer.'], + ['code' => 'InvalidParameter.MethodFilter', 'message' => 'The parameter methodFilter is invalid.', 'http_code' => 400, 'description' => 'The parameter methodFilter is invalid.'], + ['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' => 'The Name parameter is not valid. Check the Name parameter, which is between 6 and 128 characters. After modification, call the interface again.'], + ['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' => 'The incoming domain name or some domain names cannot be found based on the user and product type.'], + ['code' => 'InvalidParameter.NotMatchedCoverage', 'message' => 'The domain name and the coverage of the site are inconsistent.', 'http_code' => 400, 'description' => 'The domain name and the acceleration area of the site are inconsistent.'], + ['code' => 'InvalidParameter.NotMatchedRootDomain', 'message' => 'The domain name does not match the root domain name information for the site.', 'http_code' => 400, 'description' => 'The domain name does not match the root domain name information for the site.'], + ['code' => 'InvalidParameter.NotSupportedDomainBiz', 'message' => 'The business type of the domain name is not supported.', 'http_code' => 400, 'description' => 'The business type of the domain name is not supported.'], + ['code' => 'InvalidParameter.NotSupportedDomainStatus', 'message' => 'The status of the domain name is not allowed.', 'http_code' => 400, 'description' => 'The status of the domain name is not allowed.'], + ['code' => 'InvalidParameter.NotSupportedMultiChannelDomain', 'message' => 'The multi-channel domain are not supported.', 'http_code' => 400, 'description' => 'Multi-channel domain names are not supported.'], + ['code' => 'InvalidParameter.NotSupportVendor', 'message' => 'Do not support the vendor, please select the vendor supported.', 'http_code' => 400, 'description' => 'Do not support the vendor, please select the vendor supported.'], + ['code' => 'InvalidParameter.ObjectId', 'message' => 'Invalid task ID or execution plan ID.', 'http_code' => 400, 'description' => 'Invalid task ID or execution plan ID.'], + ['code' => 'InvalidParameter.ObjectsAndSiteIds', 'message' => 'The specified Objects and SiteIds variables cannot both be empty strings.', 'http_code' => 400, 'description' => 'The specified Objects and SiteIds variables cannot both be empty strings.'], + ['code' => 'InvalidParameter.OrderKey', 'message' => 'The specified OrderKey is invalid. Please check the OrderKey parameter.', 'http_code' => 400, 'description' => 'The OrderKey parameter is invalid. Please check the OrderKey parameter, as it cannot be assigned illegal characters such as @, #, % etc. Please make the necessary modifications and call the interface again.'], + ['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' => 'The OrderType parameter is invalid. Please check the OrderType parameter. You may not have set it to Asc or Desc. Please modify it and call the interface again.'], + ['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' => 'Failed to verify parameter PageNumber.Check whether the parameter exists and is set to a positive integer.'], + ['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' => 'The Percentage parameter is invalid. Check the Percentage parameter. The parameter range is 1-100. Modify the parameter and call the interface again.'], + ['code' => 'InvalidParameter.Port', 'message' => 'Invalid edge port or origin port. Enter a valid port as required in the interface document.', 'http_code' => 400, 'description' => 'Invalid edge port or origin port. Enter a valid port as required in the interface document.'], + ['code' => 'InvalidParameter.Protocol', 'message' => 'Invalid port protocol. Enter a valid port protocol as required by the interface documentation.', 'http_code' => 400, 'description' => 'Invalid port protocol. Enter a valid port protocol as required by the interface documentation.'], + ['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' => 'The PublishEnv parameter is invalid. Please check the PublishEnv parameter. You may not have set it to prod or staging one of them. Please modify it and call the interface again.'], + ['code' => 'InvalidParameter.RecordCommentExceedLimit', 'message' => 'The number of incoming record comment exceeds the maximum limit.', 'http_code' => 400, 'description' => 'The record comment information is greater than 50 characters.'], + ['code' => 'InvalidParameter.RecordData', 'message' => 'Invalid record content. Adjust your configurations based on the API documentation.', 'http_code' => 400, 'description' => 'Invalid record content. Adjust your configurations based on the API documentation.'], + ['code' => 'InvalidParameter.RecordNameExceedLimit', 'message' => 'The length of the record name exceeds the maximum limit.', 'http_code' => 400, 'description' => 'The record name cannot exceed 200 characters.'], + ['code' => 'InvalidParameter.RecordNotBelongToSite', 'message' => 'The record name passed in does not belong to the current site.', 'http_code' => 400, 'description' => 'The record name passed in does not belong to the current site.'], + ['code' => 'InvalidParameter.RecordsExceedLimit', 'message' => 'The number of incoming records exceeds the maximum limit.', 'http_code' => 400, 'description' => 'The number of incoming records exceeds the maximum limit.'], + ['code' => 'InvalidParameter.RecordType', 'message' => 'Invalid record type. Adjust your configurations based on the API documentation.', 'http_code' => 400, 'description' => 'Invalid record type. Adjust your configurations based on the API documentation.'], + ['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' => 'The origin of the forwarding rule does not exist or is invalid. Enter the correct origin and try again.'], + ['code' => 'InvalidParameter.SiteEnvironmentRuleDuplicate', 'message' => 'The specified site environment rule is the same as an existing environment.', 'http_code' => 400, 'description' => 'The specified site environment rule is the same as an existing environment.'], + ['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' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.'], + ['code' => 'InvalidParameter.SiteId', 'message' => 'The specified SiteId is invalid.', 'http_code' => 400, 'description' => 'The specified SiteId is invalid.Check parameter SiteId and try again.'], + ['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' => 'Invalid website name. Specify a valid name that contains letters and digits and does not contain special characters.'], + ['code' => 'InvalidParameter.SiteVersionDescExceedLimit', 'message' => 'The specified site version description exceeds the maximum length.', 'http_code' => 400, 'description' => 'The specified site version description exceeds the maximum length.'], + ['code' => 'InvalidParameter.StateFilter', 'message' => 'The parameter stateFilter is invalid.', 'http_code' => 400, 'description' => 'The parameter stateFilter is invalid.'], + ['code' => 'InvalidParameter.TagValue', 'message' => 'The specified TagValue is invalid.', 'http_code' => 400, 'description' => 'The TagValue parameter is invalid.'], + ['code' => 'InvalidParameter.TimeRange', 'message' => 'The specified time range exceeds the limit. Adjust it and try again.', 'http_code' => 400, 'description' => 'The specified time range exceeds the limit. Adjust it and try again.'], + ['code' => 'InvalidParameter.Type', 'message' => 'The specified Type parameter is invalid, please check and try again.', 'http_code' => 400, 'description' => 'The Type parameter you configured is incorrect. Please check and try again. Certificate application type support lets_encrypt, digicert_single, digicert_wildcard.'], + ['code' => 'InvalidParameter.UnSatisfiedDomainSources', 'message' => 'The basic origin sources of the domain is not satisfied.', 'http_code' => 400, 'description' => 'The basic origin information of the domain name is not satisfied.'], + ['code' => 'InvalidParameter.VanityNSNameDuplicate', 'message' => 'The vanity nameservers are duplicated. Please delete it and try again.', 'http_code' => 400, 'description' => 'Duplicate custom NS name exists, please delete and resubmit.'], + ['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' => 'The VersionId parameter 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.'], + ['code' => 'InvalidParameters', 'message' => 'The specified parameters are invalid.', 'http_code' => 400, 'description' => 'Parameter is illegal.'], + ['code' => 'InvalidParameters.InvalidUrls', 'message' => 'The specified urls are invalid.', 'http_code' => 400, 'description' => 'The requested URL parameter is invalid.'], + ['code' => 'InvalidParameter_ApiItems_Api', 'message' => 'The parameter apiItems api is invalid.', 'http_code' => 400, 'description' => 'The parameter apiItems api is invalid.'], + ['code' => 'InvalidParameter_ApiItems_Host', 'message' => 'The parameter apiItems host is invalid.', 'http_code' => 400, 'description' => 'The parameter apiItems host is invalid.'], + ['code' => 'InvalidParameter_ApiShieldQuota', 'message' => 'This website does not have the permission to view API security features.', 'http_code' => 400, 'description' => 'This website does not have the permission to view API security features.'], + ['code' => 'InvalidParameter_EndpointId', 'message' => 'The EndpointId is invalid.', 'http_code' => 400, 'description' => 'The EndpointId is invalid.'], + ['code' => 'InvalidParameter_FuzzySearch', 'message' => 'The parameter fuzzySearch is invalid.', 'http_code' => 400, 'description' => 'The parameter fuzzySearch is invalid.'], + ['code' => 'InvalidParameter_MethodFilter', 'message' => 'The parameter methodFilter is invalid.', 'http_code' => 400, 'description' => 'The parameter methodFilter is invalid.'], + ['code' => 'InvalidParameter_StateFilter', 'message' => 'The parameter stateFilter is invalid.', 'http_code' => 400, 'description' => 'The parameter stateFilter is invalid.'], + ['code' => 'InvalidRegionId.Malformed', 'message' => 'The specified RegionId is invalid.', 'http_code' => 400, 'description' => 'The RegionId parameter is set to an invalid value.'], + ['code' => 'InvalidResourceId.NotFound', 'message' => 'The specified resource does not exist or is released.', 'http_code' => 404, 'description' => 'The resource does not exist or has been released.'], + ['code' => 'InvalidRoutine', 'message' => 'The name of routine is invalid.', 'http_code' => 400, 'description' => 'Edge function name is illegal.'], + ['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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.'], + ['code' => 'InvalidSiteName', 'message' => 'Invalid website name. Check and try again.', 'http_code' => 400, 'description' => 'Invalid website name. Check and try again.'], + ['code' => 'InvalidSSLPri', 'message' => 'The specified PrivateKey is invalid.', 'http_code' => 400, 'description' => 'The value specified for the PrivateKey parameter is invalid.'], + ['code' => 'InvalidSSLPub', 'message' => 'The specified Certificate is invalid.', 'http_code' => 400, 'description' => 'The value specified for the Certificate parameter is invalid.'], + ['code' => 'InvalidStartTime.Malformed', 'message' => 'The specified StartTime parameter is invalid.', 'http_code' => 400, 'description' => 'Please provide the correct start time format. The date format follows ISO8601 notation and uses UTC time in the format yyyy-MM-ddTHH:mm:ssZ.'], + ['code' => 'InvalidStartTime.ValueNotSupported', 'message' => 'The StartTime cannot exceed 31 days before the current time.', 'http_code' => 400, 'description' => 'The request parameter StartTime cannot be 31 days less than the current time.'], + ['code' => 'InvalidStationParameter', 'message' => 'The specified Station is invalid.', 'http_code' => 400, 'description' => 'The specified node parameter is invalid.'], + ['code' => 'InvalidTaskId.Malformed', 'message' => 'The specified taskId is invalid.', 'http_code' => 400, 'description' => 'The specified task ID is invalid.'], + ['code' => 'InvalidTime', 'message' => 'The query time cannot exceed the last 3 days.', 'http_code' => 400, 'description' => 'The query time cannot exceed the last 3 days.'], + ['code' => 'InvalidTime.Malformed', 'message' => 'Specified start time or end time is malformed.', 'http_code' => 400, 'description' => 'The specified time format is incorrect. The time must conform to the yyyy-MM-ddTHH:mm:ssZ format. Please enter it correctly and try again.'], + ['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' => '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.'], + ['code' => 'InvalidValOfDelHeader', 'message' => 'The delete header operation does not support setting value.', 'http_code' => 400, 'description' => 'The delete header operation does not support setting value.'], + ['code' => 'InvalidValue.ExceedsMaximum', 'message' => 'The size of the value cannot exceed 2,000,000 bytes.', 'http_code' => 400, 'description' => 'The value deposited is too large.'], + ['code' => 'InvalidVersion.NotFound', 'message' => 'The version does not exist.', 'http_code' => 400, 'description' => 'This version number does not exist.'."\n"], + ['code' => 'IpaNotActive', 'message' => 'The ipa application is not active.', 'http_code' => 400, 'description' => 'The ipa application is not active.'], + ['code' => 'IpaResourceUnavailable', 'message' => 'The resource is unavailable.', 'http_code' => 400, 'description' => 'The resource is unavailable.'], + ['code' => 'List.BeingBound', 'message' => 'The specified list is being bound.', 'http_code' => 403, 'description' => 'The specified list is being bound by one or more protection rules.'], + ['code' => 'List.Name.AlreadyExist', 'message' => 'The specified list name already exists.', 'http_code' => 403, 'description' => 'The specified list name is already used by another list.'], + ['code' => 'List.NotExist', 'message' => 'The specified list does not exist.', 'http_code' => 403, 'description' => 'The specified list does not exist.'], + ['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' => '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.'], + ['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' => 'Your current plan does not allow you to configure the load balancer\'s health detection. Upgrade the plan and try again.'], + ['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' => 'The load balancer name or the hostname for the origin pool already exists. Try again with a unique name.'], + ['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' => '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.'], + ['code' => 'LoadBalancerNotExist', 'message' => 'The load balancer does not exist.', 'http_code' => 400, 'description' => 'The input load balancer ID does not exist. Please confirm the ID and try again.'], + ['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' => '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.'], + ['code' => 'LoadBalancerPolicyCheckFailed', 'message' => 'Your current plan does not support the load balancer scheduling policy. Upgrade the plan and try again.', 'http_code' => 400, 'description' => 'Your current plan does not support the load balancer scheduling policy. Upgrade the plan and try again.'], + ['code' => 'LoadBalancerQuotaCheckFailed', 'message' => 'Load balancer enable quota check failed.', 'http_code' => 400, 'description' => 'Your current plan cannot use the load balancer related functions. If you need to use it, upgrade the plan.'], + ['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' => '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.'], + ['code' => 'LockFailed', 'message' => 'The system is handling requests you previously submitted. Try again later.', 'http_code' => 400, 'description' => 'The system is handling requests you previously submitted. Try again later.'], + ['code' => 'LogNotFound', 'message' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', 'http_code' => 404, 'description' => 'Failed to query the log. Check whether the task ID and execution ID are valid.'], + ['code' => 'LogserviceNotFound', 'message' => 'Log Service has not been activated.', 'http_code' => 403, 'description' => 'Real-time log delivery is not activated.'], + ['code' => 'LogstoreNotExist', 'message' => 'Logstore does not exist.', 'http_code' => 404, 'description' => 'The specified Logstore does not exist.'], + ['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' => 'Failed to delete the WAF managed rule group because it has been associated with one or more rules. Disassociate the rules and try again.'], + ['code' => 'ManagedRulesGroup.Name.Invalid', 'message' => 'Invalid name for the WAF managed rule group. Try again with a valid name.', 'http_code' => 403, 'description' => 'Invalid name for the WAF managed rule group. Try again with a valid name.'], + ['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' => '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.'], + ['code' => 'Match.Malformed', 'message' => 'The specified parameter match is malformed or does not adhere to the required format.', 'http_code' => 403, 'description' => 'The specified Match parameter is malformed or does not adhere to the required format.'], + ['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' => 'When importing domain name configurations, you need to pass in the specific feature configurations, but they are not received.'], + ['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' => 'The following conditions are not supported in the Import Domain Name Configuration Tool. Check the following information and execute again:'."\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.'], + ['code' => 'MissingConfigId', 'message' => 'Required parameter ConfigId missing. Specify ConfigId and try again.', 'http_code' => 400, 'description' => 'Required parameter ConfigId missing. Specify ConfigId and try again.'], + ['code' => 'MissingOssUrl', 'message' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', 'http_code' => 400, 'description' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.'], + ['code' => 'MissingParameter', 'message' => 'Required parameter RecordName missing. Specify RecordName and try again.', 'http_code' => 400, 'description' => 'Required parameter RecordName missing. Specify RecordName and try again.'], + ['code' => 'MissingParameter', 'message' => 'The specified ArgName is required for this function.', 'http_code' => 400, 'description' => 'When configuring a specific function, the required parameter is missing.'], + ['code' => 'MissingParameter.ObjectType', 'message' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', 'http_code' => 400, 'description' => 'Specify the ObjectType parameter.'], + ['code' => 'MissingParamsError', 'message' => 'Missing required params.', 'http_code' => 400, 'description' => 'Missing necessary parameters'], + ['code' => 'MissingSiteId', 'message' => 'Required parameter SiteId missing. Specify SiteId and try again.', 'http_code' => 400, 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.'], + ['code' => 'MissingTimeParameter', 'message' => 'The StartTime and EndTime must be both specified.', 'http_code' => 400, 'description' => 'Please provide both a start time and an end time.'], + ['code' => 'MissingUrlList', 'message' => 'Enter the URLs you want to prefetch.', 'http_code' => 400, 'description' => 'Enter the URLs you want to prefetch.'], + ['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' => 'Invalid response body. Specify a response body that does not exceed 102,400 characters in length in your custom rule.'], + ['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' => '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.'], + ['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' => 'The incoming monitor is carrying an illegal request header. Make sure that the number of request headers does not exceed 10, that each request header has a value length between 1 and 10, and that you must not use the User-Agent request header (which is reserved for internal specific scenarios). In addition, the total length of all request headers and their values must not exceed 6000 characters. Please check and correct the request header configuration and try again.'], + ['code' => 'MonitorMethodNotSupport', 'message' => 'Invalid HTTP method for the probe request. Valid values are GET and HEAD.', 'http_code' => 400, 'description' => 'Invalid HTTP method for the probe request. Valid values are GET and 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' => '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.'], + ['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' => 'The incoming monitor listening port is not supported. The port value range is [1-65535]. Please ensure that the port is within the value range and try again.'], + ['code' => 'MonitorRetriesInvalid', 'message' => 'Invalid number of probe retries. Specify an integer from 0 to 5. Then, try again.', 'http_code' => 400, 'description' => 'Invalid number of probe retries. Specify an integer from 0 to 5. Then try again.'], + ['code' => 'MonitorTimeoutInvalid', 'message' => 'Invalid timeout for the probe. Valid values are 1 to 10.', 'http_code' => 400, 'description' => 'Invalid timeout for the probe. Valid values are 1 to 10.'], + ['code' => 'MonitorTypeNotSupport', 'message' => 'Invalid protocol. Valid values are off, HTTP, HTTPS, TCP, UDP, ICMP Ping, and SMTP.', 'http_code' => 400, 'description' => 'Invalid protocol. Valid values are off, HTTP, HTTPS, TCP, UDP, ICMP Ping, and SMTP.'], + ['code' => 'NameAlreadyExists', 'message' => 'The name already exists.', 'http_code' => 400, 'description' => 'Name already exists.'], + ['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' => '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).'], + ['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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.'], + ['code' => 'NoAvaliablePaymentMethod', 'message' => 'No payment method is specified for your account. We recommend that you add a payment method.', 'http_code' => 400, 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.'], + ['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' => '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.'], + ['code' => 'NoPermission', 'message' => 'Permission denied.', 'http_code' => 400, 'description' => 'No permission'], + ['code' => 'NoRealNameAuthentication', 'message' => 'You have not completed real-name authentication.', 'http_code' => 400, 'description' => 'You have not completed real-name authentication.'], + ['code' => 'NotExist.MigratedTask', 'message' => 'The specified task does not exist.', 'http_code' => 400, 'description' => 'The specified task does not exist.'], + ['code' => 'OperationDenied.DefaultSiteEnvironmentUneditable', 'message' => 'The rule of the default environment is not allowed to be modified.', 'http_code' => 400, 'description' => 'The rule of the default environment is not allowed to be modified.'], + ['code' => 'OperationDenied.UnsupportPlan', 'message' => 'The current plan does not support this operation. Use the correct plan instance to try again.', 'http_code' => 400, 'description' => 'The current plan does not support this operation. Use the correct plan instance to try again.'], + ['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' => 'Sites that are accessed only by NS mode can use custom NS. Please adjust your site access mode and try again.'], + ['code' => 'Order.InstanceHasUnpaidOrder', 'message' => 'You have an unpaid order. Complete the payment or cancel the order first.', 'http_code' => 400, 'description' => 'You have an unpaid order. Complete the payment or cancel the order first.'], + ['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' => 'The specified origin pool name already exists or its hostname conflicts with a load balancer name. Try again with a unique name.'], + ['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' => 'The specified origin pool does not exist or does not belong to your account or website. Check and try again.'], + ['code' => 'OriginProtectionNotExist', 'message' => 'The site is not configured with origin protection, so it cannot be modified or deleted.', 'http_code' => 400, 'description' => 'The site is not configured with origin protection, so it cannot be modified or deleted.'], + ['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' => '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.'], + ['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' => 'The specified custom error page has been associated with one or more protection rules. Dissociate the protection rules and try again.'], + ['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' => '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.'], + ['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' => '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.'], + ['code' => 'ParameterAlreadyExist', 'message' => 'Parameter uniqueness verification failed. Check for duplicate parameter values.', 'http_code' => 400, 'description' => 'Parameter uniqueness verification failed. Check for duplicate parameter values.'], + ['code' => 'ParameterNotExist', 'message' => 'The specified parameter does not exist. Check your configurations and try again.', 'http_code' => 400, 'description' => 'The specified parameter does not exist. Check your configurations and try again.'], + ['code' => 'ParamNameError', 'message' => 'The Name parameter is invalid.', 'http_code' => 400, 'description' => 'The Name parameter is illegal.'."\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' => '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.'], + ['code' => 'PolicyNameExist', 'message' => 'The policy name already exists.', 'http_code' => 400, 'description' => 'Policy name already exists.'], + ['code' => 'PolicyNotExist', 'message' => 'The policy does not exist.', 'http_code' => 400, 'description' => 'The policy does not exist. '], + ['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' => '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.'], + ['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' => 'Failed to delete the origin pool because it has been referenced.Remove all references to the pool and try again.'], + ['code' => 'PreloadQueueFull', 'message' => 'The prefetch queue is full. Try again later.', 'http_code' => 400, 'description' => 'The prefetch queue is full, and you need to retry after the queue is processed.'], + ['code' => 'PrivateKey.MissingParameter', 'message' => 'The PrivateKey parameter is required.', 'http_code' => 400, 'description' => 'Missing PrivateKey parameter.'], + ['code' => 'ProjectExist', 'message' => 'The SLS project has been associated with another account. Check the project name.', 'http_code' => 200, 'description' => 'The SLS project has been associated with another account. Check the project name.'], + ['code' => 'ProjectNotExist', 'message' => 'The project does not exist.', 'http_code' => 404, 'description' => 'Information about the project is not found.'], + ['code' => 'QueryDBError', 'message' => 'An internal exception occurred when query data, please try again later.', 'http_code' => 500, 'description' => 'An internal exception occurred when query data, please try again later.'], + ['code' => 'QueryLog.Timeout', 'message' => 'The query for standard logs timed out. Try again later.', 'http_code' => 500, 'description' => 'The query for standard logs timed out. Try again later.'], + ['code' => 'QuotaCheckFailed', 'message' => 'Failed to check free certificate Quota, please try again later.', 'http_code' => 400, 'description' => 'Failed to check free certificate Quota, please try again later.'], + ['code' => 'QuotaCheckFailed.CustomNS', 'message' => 'Custom nameservers are not allowed in your plan. Check the plan description and upgrade the plan.', 'http_code' => 400, 'description' => 'Custom nameservers are not allowed in your plan. Check the plan description and upgrade the plan.'], + ['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' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.'], + ['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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.'], + ['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' => 'Rules engine with regular expressions is not allowed in your plan. Check the plan description and upgrade the plan.'], + ['code' => 'QuotaCheckFailed.VersionManagement', 'message' => 'Insufficient quota for version management. Contact technical support.', 'http_code' => 400, 'description' => 'Insufficient quota for version management. Contact technical support.'], + ['code' => 'QuotaCheckFailed.VersionManagement', 'message' => 'The current plan\'s quota of version management is insufficient. Please try to upgrade the plan.', 'http_code' => 400, 'description' => 'The version management quota of the current package is insufficient. Please try to upgrade the package version.'], + ['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' => 'The maximum number of conditions in the rule has been reached. Check the plan description and upgrade the plan.'], + ['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' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.'], + ['code' => 'QuotaExceed.SiteCount', 'message' => 'The maximum number of websites associated with your plan has been reached.', 'http_code' => 400, 'description' => 'The maximum number of websites associated with your plan has been reached.'], + ['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' => 'The maximum number of custom certificates has been reached. Delete some and try again or upgrade your plan.'], + ['code' => 'QuotaExceed.WildCardRecord', 'message' => 'The maximum number of wildcard records has been reached. Delete some and try again.', 'http_code' => 400, 'description' => 'The maximum number of wildcard records has been reached. Delete some and try again.'], + ['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' => 'The number of wildcard records exceeds the plan quota. Contact the sales team to increase your quota.'], + ['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' => '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.'], + ['code' => 'QuotaExceeded', 'message' => 'The quota is exceeded.', 'http_code' => 403, 'description' => 'The quota is exceeded.'], + ['code' => 'QuotaExceeded', 'message' => 'You attempts have exceeded the daily limit.', 'http_code' => 400, 'description' => 'Exceeding the same day quota limit. The number of submissions today has been exhausted. You can query the number of times a quota can be used today through the quota API.'], + ['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' => 'The quota item does not exist or the purchased plan has not taken effect. Confirm and try again.'], + ['code' => 'RamAuthFailed', 'message' => 'The sub-account has no operation permission.', 'http_code' => 400, 'description' => 'The RAM user does not have the required operation permissions.'], + ['code' => 'RealTimeLog.BucketRegionError', 'message' => 'Invalid OSS bucket region. Check the region and try again.', 'http_code' => 403, 'description' => 'Invalid OSS bucket region. Check the region and try again.'], + ['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' => 'The number of Kafka Broker addresses for real-time log delivery has reached the upper limit (50).'], + ['code' => 'RealTimeLog.KafkaConfigError', 'message' => 'Invalid Kafka information for the delivery task. Check your configurations and try again.', 'http_code' => 403, 'description' => 'Invalid Kafka information for the delivery task. Check your configurations and try again.'], + ['code' => 'RealTimeLog.LogstoreExist', 'message' => 'The SLS logstore has been created within this project. Check the project name.', 'http_code' => 403, 'description' => 'A Logstore with the same name already exists in the SLS Project. Check the Logstore name.'], + ['code' => 'RealTimeLog.NameCheckFail', 'message' => 'Real-time log name field validity check failed.', 'http_code' => 403, 'description' => 'The real-time log configuration field you entered contains illegal characters. Please delete the illegal characters and try again. The allowed characters include numbers, letters, underscore "_" and spaces "".'], + ['code' => 'RealTimeLog.OssBucketQueryError', 'message' => 'Failed to query the OSS bucket. Check the bucket name and try again.', 'http_code' => 403, 'description' => 'Failed to query the OSS bucket. Check the bucket name and try again.'], + ['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' => '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.'], + ['code' => 'RealTimeLog.ProjectExistError', 'message' => 'The real-time log delivery task name already exists. Check the task name and try again.', 'http_code' => 400, 'description' => 'The real-time log delivery task name already exists. Check the task name and try again.'], + ['code' => 'RealTimeLog.RegexpCheckFail', 'message' => 'Invalid characters exist in your parameter configurations. Check your configurations and try again.', 'http_code' => 403, 'description' => 'Invalid characters exist in your parameter configurations. Check your configurations and try again.'], + ['code' => 'RealTimeLog.S3EndpointInvalidError', 'message' => 'Invalid S3 information for the delivery task. Check your configurations and try again.', 'http_code' => 403, 'description' => 'Invalid S3 information for the delivery task. Check your configurations and try again.'], + ['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' => 'You do not have permissions to create a service-linked role. 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.'], + ['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' => 'Invalid SLS information. Check whether ProjectName and LogStoreName are correctly configured and whether SLS is activated. Then, try again.'], + ['code' => 'RealTimeLog.SlsEndpointError', 'message' => 'Invalid SLS parameters for the delivery task. Check your configurations and try again.', 'http_code' => 403, 'description' => 'Invalid SLS parameters for the delivery task. Check your configurations and try again.'], + ['code' => 'RealTimeLog.SlsLogstoreQueryError', 'message' => 'Failed to query the Logstore. Check the Logstore name and try again.', 'http_code' => 403, 'description' => 'Failed to query the Logstore. Check the Logstore name and try again.'], + ['code' => 'RealTimeLog.SlsNotOpen', 'message' => 'You have not activated Alibaba Cloud SLS. Activate SLS first.', 'http_code' => 403, 'description' => 'You have not activated Alibaba Cloud SLS. Activate SLS first.'], + ['code' => 'RealTimeLog.SlsProjectExistError', 'message' => 'The SLS project already exists. Check the project name and try again.', 'http_code' => 403, 'description' => 'The SLS project already exists. Check the project name and try again.'], + ['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' => '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.'], + ['code' => 'RealtimeLogProjectExistError', 'message' => 'Realtime-log project name already exist.', 'http_code' => 400, 'description' => 'Real-time log entry name already exists'], + ['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' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.'], + ['code' => 'Record.AorAAAARecordValueContainInvalidIP', 'message' => 'The A/AAAA record value contains the invalid IP.', 'http_code' => 400, 'description' => 'When creating or editing an A/AAAA record, the record value contains an invalid IP.'], + ['code' => 'Record.AorAAAARecordValueContainIPInBlacklist', 'message' => 'The A/AAAA record value contains the blacklist IP.', 'http_code' => 400, 'description' => 'When you create or edit an A/AAAA record, the record value contains the blacklist IP.'], + ['code' => 'Record.AorAAAARecordValueIPExceedLimit', 'message' => 'The number of IP addresses exceeds the limit for the A/AAAA record.', 'http_code' => 400, 'description' => 'When creating or editing A/AAAA records, the number of IP addresses exceeds the limit. A host record only supports 8 IPv4 and 4 IPv6 IP addresses. Please adjust and try again.'], + ['code' => 'Record.CAARecordFlagExceedLimit', 'message' => 'The value of the flag parameter for a CAA record is out of range.', 'http_code' => 400, 'description' => 'The value of the flag parameter for a CAA record is out of range while creating or editing DNS record information.'], + ['code' => 'Record.CAARecordTagExceedLimit', 'message' => 'The CAA record tag has illegal characters other than issue, issuewild, and iodef.', 'http_code' => 400, 'description' => 'When creating or editing CAA records, illegal characters other than issue, issuewild, and iodef are passed in the tag value.'], + ['code' => 'Record.CERTRecordAlgorithmExceedLimit', 'message' => 'The value of the algorithm parameter for the CERT record is out of range.', 'http_code' => 400, 'description' => 'The value of the algorithm parameter for the CERT record is out of range while creating or editing DNS record information.'], + ['code' => 'Record.CERTRecordKeyTagExceedLimit', 'message' => 'The value of the keyTag parameter for a CERT record is out of range.', 'http_code' => 400, 'description' => 'The value of the keyTag parameter for a CERT record is out of range when creating or editing DNS record information.'], + ['code' => 'Record.CERTRecordTypeExceedLimit', 'message' => 'The CERT record type is out of range.', 'http_code' => 400, 'description' => 'The CERT record type parameter was out of range when creating or editing DNS record information.'], + ['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' => '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.'], + ['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' => 'The CNAME record cannot be the origin of the added source address pool. Check and try again.'], + ['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' => 'The CNAME record cannot be the origin of an added record. Check the record values of other records and try again.'], + ['code' => 'Record.CNameRecordValueCannotEqualHostRecord', 'message' => 'The record value of the CNAME record cannot be exactly the same as the host record.', 'http_code' => 400, 'description' => 'The record value of the CNAME record cannot be exactly the same as the host record. Please adjust and try again.'], + ['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' => 'The record value of a CNAME record cannot be exactly the same as the name of another existing Layer 4 proxy record.'], + ['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' => 'The record value of a CNAME record cannot be the same as the name of another existing CNAME record.'], + ['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' => 'The CNAME record value contains the blacklist address. For details, you can submit a work order for consultation.'], + ['code' => 'Record.CNameRecordValueExceedLimit', 'message' => 'The CNAME record value cannot exceed 253 characters, please delete and try again.', 'http_code' => 400, 'description' => 'The record value cannot exceed 253 characters, please delete and try again.'], + ['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' => '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.'], + ['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' => '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.'], + ['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' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.'], + ['code' => 'Record.EmptyAorAAAARecordValue', 'message' => 'The A/AAAA record value is empty, please fill it in correctly and try again.', 'http_code' => 400, 'description' => 'The A/AAAA record value is empty, please fill it in correctly and try again.'], + ['code' => 'Record.EmptyCAARecordValue', 'message' => 'The CAA record value is empty.', 'http_code' => 400, 'description' => 'When creating or editing a CAA record, the value of the record is empty inside.'], + ['code' => 'Record.EmptyCNameRecordValue', 'message' => 'The CNAME record value is empty.', 'http_code' => 400, 'description' => 'When creating or editing a CNAME record, the record value is empty. Please fill it in correctly and try again.'], + ['code' => 'Record.EmptyMXRecordValue', 'message' => 'The MX record value cannot be empty.', 'http_code' => 400, 'description' => 'When you create or edit an MX record, the record value cannot be empty.'], + ['code' => 'Record.EmptyNSRecordValue', 'message' => 'The NS record value cannot be empty.', 'http_code' => 400, 'description' => 'When you create or edit an NS record, the NS record value cannot be empty.'], + ['code' => 'Record.EmptyRecordValue', 'message' => 'The record value is empty, please fill it in correctly and try again.', 'http_code' => 400, 'description' => 'The record value is empty, please fill it in correctly and try again.'], + ['code' => 'Record.EmptyTXTRecordValue', 'message' => 'The TXT record value cannot be empty.', 'http_code' => 400, 'description' => 'When creating or editing a TXT record, the record value cannot be empty.'], + ['code' => 'Record.InvalidCertEncodeWithCERTRecord', 'message' => 'The certificate value of the CERT record is not base64-encoded.', 'http_code' => 400, 'description' => 'When you create or edit CERT record information, the certificate value of the CERT record is not base64-encoded.'], + ['code' => 'Record.InvalidFingerprintWithSSHFPRecord', 'message' => 'The SSHFP record fingerprint value is not hexadecimal encoded.', 'http_code' => 400, 'description' => 'When creating or editing SSHFP record information, the fingerprint value is not hexadecimal encoded.'], + ['code' => 'Record.InvalidHTTPURLWithCAARecordTag', 'message' => 'The CAA record is prefixed with http:// or https://, a valid URL must be followed.', 'http_code' => 400, 'description' => 'When creating or editing CAA records, when Tag is iodef and Value is prefixed with http:// or https://, a valid URL must be followed.'], + ['code' => 'Record.InvalidIdoefDataWithCAARecordTag', 'message' => 'The CAA record Tag value does not start with mailto: or http:// or https.', 'http_code' => 400, 'description' => 'When creating or editing CAA record information, the Tag value does not start with mailto: http:// https.'], + ['code' => 'Record.InvalidIodefDataWithCAARecordTag', 'message' => 'The CAA record Tag value cannot start with mailto: or http:// or https.', 'http_code' => 400, 'description' => 'When creating or editing CAA record information, the Tag value cannot start with mailto: http:// or 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' => 'When creating or editing CAA record information, the tag tag of a CAA record can only be a semicolon or a valid domain name separated by semicolons.'], + ['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' => 'When creating or editing CAA record information, when Tag is iodef and Value is prefixed with mailto:, it must be followed by a legal email address.'], + ['code' => 'Record.InvalidSmimeaEncodeWithSMIMEARecord', 'message' => 'The certificate value of the SMIMEA record is not base64-encoded.', 'http_code' => 400, 'description' => 'When creating or editing SMIMEA record information, the certificate value of the SMIMEA record is not base64-encoded.'], + ['code' => 'Record.InvalidTslaEncodeWithTSLARecord', 'message' => 'The certificate value passed in is not hexadecimal encoded with TSLA record.', 'http_code' => 400, 'description' => 'When creating or editing TLSA record information, the certificate value passed in is not hexadecimal encoded.'], + ['code' => 'Record.InvalidURLWithURIRecord', 'message' => 'The URI record value must be a valid URL address.', 'http_code' => 400, 'description' => 'When creating or editing URI record information, the record value must be a valid URL address.'], + ['code' => 'Record.MXRecordPriorityExceedLimit', 'message' => 'The MX record priority parameter value is out of range.', 'http_code' => 400, 'description' => 'When creating or editing DNS record information, the MX record priority parameter value filled in is out of range.'], + ['code' => 'Record.NoRecordNameConflictWithNSRecord', 'message' => 'No record name can conflict with an NS record name.', 'http_code' => 400, 'description' => 'No record name can conflict with an NS record name.'], + ['code' => 'Record.NoResource', 'message' => 'Failed to allocate resources for the record. Please submit a ticket for processing.', 'http_code' => 400, 'description' => 'Failed to allocate resources for the record. Please submit a work order for processing.'], + ['code' => 'Record.NotFound', 'message' => 'The record does not exist. Check your configurations and try again.', 'http_code' => 404, 'description' => 'The record does not exist. Check your configurations and try again.'], + ['code' => 'Record.NotFound', 'message' => 'The record does not exist. Modify it and try again.', 'http_code' => 404, 'description' => 'The record does not exist. Modify it and try again.'], + ['code' => 'Record.NSRecordCannotEqualSiteName', 'message' => 'An NS record with the exact same name as the site name is not allowed.', 'http_code' => 400, 'description' => 'Adding an NS record with the exact same name as the site name is not allowed.'], + ['code' => 'Record.OSSSourceInvalidAuthType', 'message' => 'The recorded OSS origin station authentication type is not supported.', 'http_code' => 400, 'description' => 'The recorded OSS origin station authentication type is not supported.'], + ['code' => 'Record.ParseJSONRecordValueFailed', 'message' => 'The JSON data format of the record data is incorrect. Please adjust and try again.', 'http_code' => 400, 'description' => 'The JSON data format of the record data is incorrect. Please adjust and try again.'], + ['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' => 'If the source station type of the record is source address pool, the input source address pool does not exist.'], + ['code' => 'Record.RecordMatchingTypeExceedLimit', 'message' => 'The matchingType parameter value filled in is out of range.', 'http_code' => 400, 'description' => 'While creating or editing DNS record information, the matchingType parameter value filled in is out of range.'], + ['code' => 'Record.RecordNameConflictForSpecifiedRecordType', 'message' => 'The A/AAAA and CNAME records cannot have the same name.', 'http_code' => 400, 'description' => 'The A/AAAA and CNAME records cannot have the same name.'], + ['code' => 'Record.RecordNameConflictWithIPAName', 'message' => 'The record name cannot have the same name as the Layer 4 proxy record.', 'http_code' => 400, 'description' => 'When you create or edit DNS record information, the record name cannot have the same name as the Layer 4 proxy record.'], + ['code' => 'Record.RecordNameConflictWithLBName', 'message' => 'The record name cannot be the same as the Server Load Balancer record name.', 'http_code' => 400, 'description' => 'When creating or editing DNS record information, the record name cannot be the same as the Server Load Balancer record name.'], + ['code' => 'Record.RecordNameConflictWithNSRecord', 'message' => 'The NS record name cannot be the same as any other type of record name.', 'http_code' => 400, 'description' => 'When creating or editing DNS record information, the NS record name cannot be the same as any other type of record name.'], + ['code' => 'Record.RecordNameConflictWithPoolName', 'message' => 'The record name cannot be the same as the source address pool record name.', 'http_code' => 400, 'description' => 'When creating or editing DNS record information, the record name cannot be the same as the source address pool record name.'], + ['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' => 'Record conflict with the same record type, there is a host record with the same name with the same record value.'], + ['code' => 'Record.RecordNameConflictWithSameRecordType', 'message' => 'Record conflicts with an existing host record that has the same name and value.', 'http_code' => 400, 'description' => 'Record conflicts with an existing host record that has the same name and value.'], + ['code' => 'Record.RecordNameInBlacklist', 'message' => 'The record name is in blacklist.', 'http_code' => 400, 'description' => 'The record name is in the blacklist and cannot be added.'], + ['code' => 'Record.RecordPriorityExceedLimit', 'message' => 'The record priority parameter value filled in is out of range.', 'http_code' => 400, 'description' => 'When creating or editing DNS record information, the record priority parameter value filled in is out of range.'], + ['code' => 'Record.RecordSelectorExceedLimit', 'message' => 'The selector parameter value filled in is out of range.', 'http_code' => 400, 'description' => 'While creating or editing DNS record information, the selector parameter value filled in is out of range.'], + ['code' => 'Record.RecordUsageExceedLimit', 'message' => 'The usage parameter value filled in is out of range.', 'http_code' => 400, 'description' => 'When creating or editing DNS record information, the usage parameter value filled in is out of range.'], + ['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' => 'The record value contains the blacklist address, and the details can be submitted for work order consultation.'], + ['code' => 'Record.RecordWeightExceedLimit', 'message' => 'The record weight parameter value filled in is out of range.', 'http_code' => 400, 'description' => 'When creating or editing DNS record information, the record weight parameter value filled in is out of range.'], + ['code' => 'Record.Reserved', 'message' => 'Another operation on the record is in progress. Try again later.', 'http_code' => 400, 'description' => 'Another operation on the record is in progress. Try again later.'], + ['code' => 'Record.S3SourceInvalidAuthRegion', 'message' => 'The recorded S3 origin belongs to a region that is not in the supported range.', 'http_code' => 400, 'description' => 'The recorded S3 origin belongs to a region that is not in the supported range.'], + ['code' => 'Record.S3SourceInvalidAuthType', 'message' => 'The recorded S3 origin authentication type is not supported.', 'http_code' => 400, 'description' => 'The recorded S3 origin authentication type is not supported.'], + ['code' => 'Record.S3SourceInvalidAuthVersion', 'message' => 'The version of the authentication signature algorithm of the S3 origin is not supported.', 'http_code' => 400, 'description' => 'The version of the authentication signature algorithm of the S3 origin is not supported.'], + ['code' => 'Record.ServiceBusy', 'message' => 'The record is being configured. Try again later.', 'http_code' => 400, 'description' => 'The record is being configured. Try again later.'], + ['code' => 'Record.SMIMEARecordMatchingTypeExceedLimit', 'message' => 'The matchingType parameter value for a SMIMEA record is out of range.', 'http_code' => 400, 'description' => 'The matchingType parameter value for a SMIMEA record is out of range while creating or editing DNS record information.'], + ['code' => 'Record.SMIMEARecordSelectorExceedLimit', 'message' => 'The selector parameter value for a SMIMEA record is out of range.', 'http_code' => 400, 'description' => 'The selector parameter value for a SMIMEA record is out of range while creating or editing DNS record information.'], + ['code' => 'Record.SMIMEARecordUsageExceedLimit', 'message' => 'The value of the usage parameter for a SMIMEA record is out of range.', 'http_code' => 400, 'description' => 'The value of the usage parameter for a SMIMEA record is out of range while creating or editing DNS record information.'], + ['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' => 'The character length of the AccessKey parameter value for the record source station is out of range.'], + ['code' => 'Record.SourceEmptyAK', 'message' => 'The AccessKey of the account to which the origin site belongs is empty.', 'http_code' => 400, 'description' => 'The AccessKey of the account to which the origin site belongs is empty.'], + ['code' => 'Record.SourceEmptyAuthConf', 'message' => 'The authentication information of the origin station is empty.', 'http_code' => 400, 'description' => 'The recorded authentication information of the origin station is empty.'], + ['code' => 'Record.SourceEmptySecretKey', 'message' => 'The SecretKey of the account to which the recorded origin site belongs is empty.', 'http_code' => 400, 'description' => 'The SecretKey of the account to which the recorded origin site belongs is empty.'], + ['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' => 'The character length of the SecretKey parameter value for the record source station is out of range.'], + ['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 host record name is not valid. The SRV host record name must begin with an underscore (-), followed by a lowercase letter (a-z), number (0-9), hyphen (-), followed by any character, followed by an underscore (-) and a lowercase letter, number, or hyphen.'], + ['code' => 'Record.SRVRecordPortExceedLimit', 'message' => 'The SRV record port is out of range.', 'http_code' => 400, 'description' => 'When creating or editing DNS record information, the SRV record port filled in is out of range.'], + ['code' => 'Record.SRVRecordPriorityExceedLimit', 'message' => 'The SRV record priority is out of range.', 'http_code' => 400, 'description' => 'The SRV record priority is out of range when creating or editing DNS record information.'], + ['code' => 'Record.SRVRecordWeightExceedLimit', 'message' => 'The SRV record weight is out of range.', 'http_code' => 400, 'description' => 'When creating or editing DNS record information, the SRV record weight filled in is out of range.'], + ['code' => 'Record.SSHFPRecordAlgorithmExceedLimit', 'message' => 'The algorithm parameter value for the SSHFP record is out of range.', 'http_code' => 400, 'description' => 'The algorithm parameter value for the SSHFP record is out of range while creating or editing DNS record information.'], + ['code' => 'Record.TLSARecordMatchingTypeExceedLimit', 'message' => 'The matchingType parameter value for the TLSA record is out of range.', 'http_code' => 400, 'description' => 'The matchingType parameter value for the TLSA record is out of range while creating or editing DNS record information.'], + ['code' => 'Record.TLSARecordSelectorExceedLimit', 'message' => 'The selector parameter value for the TLSA record is out of range.', 'http_code' => 400, 'description' => 'The selector parameter value for the TLSA record is out of range while creating or editing DNS record information.'], + ['code' => 'Record.TLSARecordUsageExceedLimit', 'message' => 'The value of the usage parameter for the TLSA record is out of range.', 'http_code' => 400, 'description' => 'The value of the usage parameter for the TLSA record is out of range while creating or editing DNS record information.'], + ['code' => 'Record.TTLExceedLimit', 'message' => 'The TTL parameter value for a record is out of range.', 'http_code' => 400, 'description' => 'The TTL parameter value for a record is out of range while creating or editing DNS record information.'], + ['code' => 'Record.TXTRecordValueExceedLimit', 'message' => 'The TXT record value cannot exceed 450 characters.', 'http_code' => 400, 'description' => 'When you create or edit DNS record information, the TXT record value cannot exceed 450 characters.'], + ['code' => 'Record.TypeExceedLimitWithSSHFPRecord', 'message' => 'The SSHFP record Type parameter value is out of range.', 'http_code' => 400, 'description' => 'The SSHFP record Type parameter value is out of range while creating or editing DNS record information.'], + ['code' => 'Record.UnmatchedRecordNameContainDoubleConsecutiveDot', 'message' => 'Illegal host record name. The host record cannot contain consecutive dot.', 'http_code' => 400, 'description' => 'Illegal host record name. The host record cannot contain consecutive dot.'], + ['code' => 'Record.UnmatchedRecordNameForbidStarSev', 'message' => 'Illegal host record name, SRV record name disallowed asterisk.', 'http_code' => 400, 'description' => 'Illegal host record name, SRV record name disallowed asterisk.'], + ['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' => 'Illegal host record name. The \'@\' symbol can only appear at the top of the host record and can only be followed. Symbol, other strings are not allowed.'], + ['code' => 'Record.UnmatchedRecordNameInvalidNamePrefixSuffix', 'message' => 'Illegal host record name. Host record values cannot start or end with a dot, a hyphens.', 'http_code' => 400, 'description' => 'Illegal host record name. Host record values cannot start or end with a dot, a hyphens.'], + ['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' => '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.'], + ['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' => 'The host record name contains an illegal underscore. The underscore can only be used at the beginning of TXT, CAA, CNAME, NS, and SRV records. Proxy acceleration cannot be enabled and records can only be added in 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' => '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.'], + ['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' => 'The host record value cannot exist separately in various symbols, and can be added with any lowercase letters or numbers.'."\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' => 'The host record value cannot exist separately in various symbols, and can be added with any lowercase letters or numbers.'], + ['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' => 'Illegal host record character. Only lowercase a-z, uppercase A-Z, digits 0-9, \'-\', \'_\', \'.\', \'*\', and \'@\' are supported as valid characters in host records.'], + ['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' => 'Illegal host record name. The number of characters in each segment separated by \'.\' cannot exceed 63.'], + ['code' => 'Record.UnsupportedSourceType', 'message' => 'The recorded source station type is not in the supported range.', 'http_code' => 400, 'description' => 'The recorded source station type is not in the supported range.'], + ['code' => 'Record.UnsupportedType', 'message' => 'The record type parameter is unsupported.', 'http_code' => 400, 'description' => 'The record type parameter is incorrect. Please check the record type parameter.'], + ['code' => 'Record.URIRecordPriorityExceedLimit', 'message' => 'The value of the priority parameter for a URI record is out of range.', 'http_code' => 400, 'description' => 'The value of the priority parameter for a URI record is out of range while creating or editing DNS record information.'], + ['code' => 'Record.URIRecordWeightExceedLimit', 'message' => 'The URI record weight parameter value is out of range.', 'http_code' => 400, 'description' => 'The URI record weight parameter value is out of range while creating or editing DNS record information.'], + ['code' => 'Record.ValidProxiedForSpecifedRecordType', 'message' => 'Only A/AAAA and CNAME types support proxy acceleration.', 'http_code' => 400, 'description' => 'When creating or editing a record, proxy acceleration is enabled in the proxy state. Only A/AAAA and CNAME types support proxy acceleration.'], + ['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 records cannot add all and asterisk prefixed records at the same time.'], + ['code' => 'Record.WildcartConflictForSpecifiedRecordType', 'message' => 'The A/AAAA,CNAME records cannot add all and asterisk prefixed records at the same time.', 'http_code' => 400, 'description' => 'The A/AAAA,CNAME records cannot add all and asterisk prefixed records at the same time.'], + ['code' => 'RecordNameInBalckList', 'message' => 'The record name is in the blacklist.', 'http_code' => 400, 'description' => 'The record name is in the blacklist.'], + ['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' => '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.'], + ['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' => '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.'], + ['code' => 'RelatedSiteNumberExceedQuotaLimit', 'message' => 'The maximum number of websites that can be associated with the routine has been reached.', 'http_code' => 400, 'description' => 'The maximum number of websites that can be associated with the routine has been reached.'], + ['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' => 'Free certificates cannot be requested for a website that is not in the active state. Activate the website first.'], + ['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' => 'In order to protect the security of your account, the order was suspended, please contact customer service for details.'], + ['code' => 'RoutineAlreadyExist', 'message' => 'The routine name already exists.', 'http_code' => 400, 'description' => 'The routine name already exists.'], + ['code' => 'RoutineCodeVersionStatusNotAvailable', 'message' => 'The routine code version status not Available. Check the routine code version status and try again.', 'http_code' => 400, 'description' => 'The routine code version status is not Available. Check the status and try again.'], + ['code' => 'RoutineNotExist', 'message' => 'The routine name does not exist. Check the routine name and try again.', 'http_code' => 400, 'description' => 'The routine name does not exist. Check the routine name and try again.'], + ['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' => 'The maximum number of configuration items for the feature has been reached. Adjust your configurations and try again.'], + ['code' => 'RoutineUserServiceStatusHalt', 'message' => 'Failed to update the configurations because you have overdue payments.', 'http_code' => 400, 'description' => 'Failed to update the configurations because you have overdue payments.'], + ['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' => '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.'], + ['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' => '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.'], + ['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' => '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.'], + ['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' => 'The format of the rule configuration is invalid.Check the configuration for syntax errors or structural inconsistencies and correct them to meet the requirements.'], + ['code' => 'Rule.Config.Noncompliance', 'message' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', 'http_code' => 403, 'description' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.'], + ['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' => 'The specified rule name already exists.Try again with a unique name or modify the existing rule name.'], + ['code' => 'Rule.NotExist', 'message' => 'The specified rule does not exist.', 'http_code' => 400, 'description' => 'The specified rule does not exist in the current context or system configuration. Please verify the existence of the rule identifier and ensure it has been correctly defined or implemented.'], + ['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' => 'The specified position for the rule is invalid.Check and adjust the configuration to make sure it meets the requirements.'], + ['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' => 'Failed to compile the rule. Check your rule configurations and make sure they are in the valid format as described in the API documentation.'], + ['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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.'], + ['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' => 'The specified rule set name already exists.Try again with a unique name or modify the existing rule set name.'], + ['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' => '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.'], + ['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' => 'The maximum number of records with the same name added in batches exceeds 5. Add records with the same name in batches or reduce the number of records with the same name added in batches.'], + ['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' => 'The maximum number of scenario policies has been reached. Each account can create up to 10 scenario policies.'], + ['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' => 'Failed to call the service. Please try again later or contact customer service for details.'], + ['code' => 'ServiceNotOpen', 'message' => 'You have not activated Edge Routine. Activate the service and try again.', 'http_code' => 400, 'description' => 'You have not activated Edge Routine. Activate the service and try again.'], + ['code' => 'Site.AlreadyExist', 'message' => 'The website name you specified already exists. Try with another name.', 'http_code' => 400, 'description' => 'The website name you specified already exists. Try with another name.'], + ['code' => 'Site.Conflict', 'message' => 'Duplicate website names exist across multiple accounts. Rename or delete one and try again.', 'http_code' => 400, 'description' => 'Duplicate website names exist across multiple accounts. Rename or delete one and try again.'], + ['code' => 'Site.InBlacklist', 'message' => 'The site name is in the blacklist.', 'http_code' => 400, 'description' => 'The site name is in the blacklist.'], + ['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' => 'The selected location is unavailable in your plan. Change the location to one that is covered by the plan and try again.'], + ['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' => '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.'], + ['code' => 'Site.NotSupportedStatus', 'message' => 'The current site state is not supported.', 'http_code' => 400, 'description' => 'The current site state is not supported.'], + ['code' => 'Site.ServiceBusy', 'message' => 'This website is being configured. Try again later.', 'http_code' => 400, 'description' => 'This website is being configured. Try again later.'], + ['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' => '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.'], + ['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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The environment name or rule conflicts with an existing environment. Try again with a different environment name or rule.'], + ['code' => 'SiteEnvironment.DeleteDenied', 'message' => 'The default environment cannot be deleted.', 'http_code' => 400, 'description' => 'The default environment cannot be deleted.'], + ['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' => 'You have entered an invalid site version environment, or the site does not have version management enabled. Please confirm that your version environment settings are correct, and activate the version management function if necessary, and then try again.'], + ['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' => '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.'], + ['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' => 'The current site has an existing four-layer accelerated application, and the current operation is not allowed. If necessary, please contact customer service.'], + ['code' => 'SiteIdDDoSVersionCheckFailed', 'message' => 'SiteId DDoS version check failed.', 'http_code' => 403, 'description' => 'Failed to check the DDoS version corresponding to the site.'], + ['code' => 'SiteNotActivated', 'message' => 'The site is not activated, the process is not allowed.', 'http_code' => 400, 'description' => 'The operation is not supported because the site is not activated.'], + ['code' => 'SiteNotFound', 'message' => 'The specified site is not found.', 'http_code' => 400, 'description' => 'The site you specified does not exist. Please check whether the site you entered is correct.'], + ['code' => 'SiteNotFound', 'message' => 'The website does not exist or does not belong to you.', 'http_code' => 404, 'description' => 'The website does not exist or does not belong to you.'], + ['code' => 'SiteParameterNotMatch', 'message' => 'Failed to verify website parameters.Check the parameters and try again.', 'http_code' => 400, 'description' => 'Failed to verify website parameters.Check the parameters and try again.'], + ['code' => 'SiteVerify.Unpassed', 'message' => 'Domain ownership verification failed. Complete the verification and try again.', 'http_code' => 200, 'description' => 'Domain ownership verification failed. Complete the verification and try again.'], + ['code' => 'SiteVersion.Configuring', 'message' => 'The version is being configured. Try again later.', 'http_code' => 400, 'description' => 'The version is being configured. Try again later.'], + ['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' => '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.'], + ['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' => '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.'], + ['code' => 'SourceAddressInvalid', 'message' => 'Invalid origin address. Check whether the IP address or domain name is in the valid format.', 'http_code' => 400, 'description' => 'Invalid origin address. Check whether the IP address or domain name is in the valid format.'], + ['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' => '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.'], + ['code' => 'SourceInBlackList', 'message' => 'The source is in the black list.', 'http_code' => 400, 'description' => 'The source is in the black list.'], + ['code' => 'SourceNumberExceedLimit', 'message' => 'The number of sources in the origin pool exceeds the quota limit.', 'http_code' => 400, 'description' => 'The number of sources that can be created in the origin pool has reached the upper limit of the package. Please check your package quota and upgrade the package to obtain more quota.'], + ['code' => 'SourceTypeNotSupport', 'message' => 'Invalid origin type. Valid values are ip_domain, OSS, FC, and S3.', 'http_code' => 400, 'description' => 'Invalid origin type. Valid values are ip_domain, OSS, FC, and 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' => 'Specifications exceed the limit, paid version can use 50ms, 100ms, free version can only use 5ms'], + ['code' => 'SpecifiedVersionReadOnly', 'message' => 'The specified version number is read-only and cannot be modified.', 'http_code' => 400, 'description' => 'The specified version number is read-only and cannot be modified.'], + ['code' => 'SubSiteUnavailable', 'message' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.', 'http_code' => 400, 'description' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.'], + ['code' => 'SYSTEM.NoSpecificCodeFailed', 'message' => 'Invalid subscription duration. Check and try again.', 'http_code' => 400, 'description' => 'Invalid subscription duration. Check and try again.'], + ['code' => 'TooManyDimensions', 'message' => 'Too many query dimensions specified. Delete some and try again.', 'http_code' => 400, 'description' => 'Too many query dimensions specified. Delete some and try again.'], + ['code' => 'TooManyRequests', 'message' => 'Too many requests.Please try again later.', 'http_code' => 400, 'description' => 'Requests are too frequent, please try again later.'], + ['code' => 'TooManyRequests', 'message' => 'Too many requests are submitted.', 'http_code' => 429, 'description' => 'Submissions are too frequent, please try again later'], + ['code' => 'TooManyRequests', 'message' => 'System load fluctuates, please try again later.', 'http_code' => 429, 'description' => 'System load fluctuates, please try again later.'], + ['code' => 'TooQuickRequests', 'message' => 'Request for putting or deleting keys are frequently submitted.', 'http_code' => 429, 'description' => 'The modification or deletion of key-value pairs is too frequent.'], + ['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' => 'The Layer -4 accelerated application conflicts with other applications. Check whether the application name and host record conflict with other applications in the site.'], + ['code' => 'TransportLayerApplicationNotExist', 'message' => 'The layer -4 accelerated application of the current operation does not exist. Modify it and try again.', 'http_code' => 400, 'description' => 'The layer -4 accelerated application of the current operation does not exist. Modify it and try again.'], + ['code' => 'TransportLayerRulesExceedLimit', 'message' => 'The configured forwarding rules have exceeded the maximum limit. Delete useless forwarding rules and try again.', 'http_code' => 400, 'description' => 'The configured forwarding rules have exceeded the maximum limit. Delete useless forwarding rules and try again.'], + ['code' => 'TrialService.HasOpened', 'message' => 'You have already activated the trial service.', 'http_code' => 400, 'description' => 'You have activated the trial service and cannot activate it again.'], + ['code' => 'Unauthorized.InvalidParameters', 'message' => 'The specified authentication parameters are invalid.', 'http_code' => 403, 'description' => 'Authentication parameter input error.'], + ['code' => 'Unauthorized.InvalidTime', 'message' => 'The specified authentication time is invalid.', 'http_code' => 403, 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.'], + ['code' => 'Unauthorized.InvalidToken', 'message' => 'Token authentication failed.', 'http_code' => 403, 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.'], + ['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' => '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.'], + ['code' => 'Unsupported.ConvertRecord', 'message' => 'Converting site records is not supported in migration tasks.', 'http_code' => 400, 'description' => 'Converting site records is not supported in migration tasks.'], + ['code' => 'Unsupported.DomainSourceConvertToRecord', 'message' => 'Converting the domain sources to a site record is not supported in migration tasks.', 'http_code' => 400, 'description' => 'Converting the domain sources to a site record is not supported.'], + ['code' => 'UnsupportQuota', 'message' => 'Unsupported quota is specified. Check and try again.', 'http_code' => 404, 'description' => 'Unsupported quota is specified. Check and try again.'], + ['code' => 'UpdateErServiceError', 'message' => 'Failed to change the plan. You are only allowed to change your plan once within 24 hours.', 'http_code' => 400, 'description' => 'Failed to change the plan. You are only allowed to change your plan once within 24 hours.'], + ['code' => 'UpdateFreeCertificate.NotSupport', 'message' => 'The free certificate does not support the update operation.', 'http_code' => 400, 'description' => 'The free certificate does not support the update operation.'], + ['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' => 'The configuration for the upgrade or downgrade is not changed.'], + ['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' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.'], + ['code' => 'UserQuantityExceed', 'message' => 'Your current purchase quantity exceeds the available quantity. Please select a new quantity.', 'http_code' => 400, 'description' => 'Your current purchase quantity exceeds the available quantity. Please select a new quantity.'], + ['code' => 'UserWithoutConfLabel', 'message' => 'Required tags missing. Configure tags and try again.', 'http_code' => 400, 'description' => 'Required tags missing. Configure tags and try again.'], + ['code' => 'VerifyExpressionError', 'message' => 'Dynamic expression is invalid.', 'http_code' => 400, 'description' => 'Dynamic expression is invalid.'], + ['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' => 'The NS verification failed. Please configure the NS provided by ESA on the domain name management platform and try again.'], + ['code' => 'VersionNotValid', 'message' => 'The site does not have version management enabled, or the version number passed in does not exist.', 'http_code' => 400, 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.'], + ['code' => 'WaitingRoomEventNotExist', 'message' => 'The waiting room event that you want to modify does not exist. Specify a valid one.', 'http_code' => 400, 'description' => 'The waiting room event that you want to modify does not exist. Specify a valid one.'], + ['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' => 'The waiting room that you want to modify does not exist or does not belong to you. Confirm and try again.'], + ['code' => 'WaitingRoomRuleNotExist', 'message' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.', 'http_code' => 400, 'description' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.'], + ['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' => '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.'], + ['code' => 'GitAccountNotExist', 'message' => 'Git account does not exist.', 'http_code' => 400, 'description' => 'Git account does not exist.'], + ['code' => 'InvalidRoutineBuildTaskStatus', 'message' => 'Routine build configuration state that does not exist.', 'http_code' => 400, 'description' => 'Routine build configuration state that does not exist.'], + ['code' => 'RoutineInstanceNotExist', 'message' => 'The Routine instance does not exist.', 'http_code' => 400, 'description' => 'The Routine instance does not exist.'], + ['code' => 'GitAccountAuthExpired', 'message' => 'Git account authorization expired.', 'http_code' => 400, 'description' => 'Git account authorization expired.'], + ['code' => 'GitAccountAlreadyExist', 'message' => 'The Git account already exists and cannot be created repeatedly.', 'http_code' => 400, 'description' => 'The Git account already exists and cannot be created repeatedly.'], + ['code' => 'GitAccountNotActive', 'message' => 'Git account is not active.', 'http_code' => 400, 'description' => 'Git account is not active.'], + ['code' => 'RoutineNotExist', 'message' => 'Routine does not exist.', 'http_code' => 400, 'description' => 'Routine does not exist.'], + ['code' => 'RoutineBuildTaskNotExist', 'message' => 'Routine build task does not exist.', 'http_code' => 400, 'description' => 'Routine build task does not exist.'], + ['code' => 'IllegalNodeVersion', 'message' => 'NodeVersion parameter is illegal.', 'http_code' => 400, 'description' => 'NodeVersion parameter is illegal.'], + ['code' => 'RoutineBuildConfigurationNotExist', 'message' => 'Routine build configuration does not exist.', 'http_code' => 400, 'description' => 'Routine build configuration does not exist.'], + ['code' => 'RoutineBuildConfigurationExist', 'message' => 'Routine build configuration already exists.', 'http_code' => 400, 'description' => 'Routine build configuration already exists.'], + ['code' => 'RoutineBuildTaskNotBuilding', 'message' => 'The state of the Routine build task is not building.', 'http_code' => 400, 'description' => 'The state of the Routine build task is not building.'], + ['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' => 'The number of Git accounts exceeds the quota limit. A user can only associate up to 20 Git accounts.'], + ['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' => '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.'], + ['code' => 'EnvironmentExceedLimit', 'message' => 'The environment variable parameter exceeds the limit, and the number of keys and values exceeds the limit.', 'http_code' => 400, 'description' => 'The environment variable parameter exceeds the limit, and the number of keys and values exceeds the limit.'], + ['code' => 'RepositoryExceedLimit', 'message' => 'One code repository can only be associated with up to 10 Routine build configurations.', 'http_code' => 400, 'description' => 'One code repository can only be associated with up to 10 Routine build configurations.'], + ['code' => 'CanNotOpenCrossBorderOptimization', 'message' => 'Can not open cross border optimization.', 'http_code' => 400, 'description' => 'Can not open cross border optimization.'], + ['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' => 'The custom hostname conflicts with existing resources, such as sites, records, load balancers, source address pools, custom hostnames and Layer 4 proxy records.'], + ['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' => 'The number of custom hostnames exceeds the plan quota. Contact the sales team to increase your quota.'], + ['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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.'], + ['code' => 'CustomHostname.VerifyUnpassed', 'message' => 'The custom hostname ownership verification failed. Complete the verification and try again.', 'http_code' => 200, 'description' => 'The custom hostname ownership verification failed. Complete the verification and try again.'], + ['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' => 'Failed to delete the record because it is the source of existing custom hostnames.Remove all references to the record and try again.'], + ['code' => 'CustomHostname.NotFound', 'message' => 'The custom hostname does not exist. Modify it and try again.', 'http_code' => 404, 'description' => 'The custom hostname does not exist. Modify it and try again.'], + ['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' => 'Failed to delete the record because it is the origin server of existing custom hostnames.Remove all references to the record and try again.'], + ['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' => '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.'], + ['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' => '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.'], + ['code' => 'CustomHostname.ServiceBusy', 'message' => 'The custom hostname is being configured. Try again later.', 'http_code' => 400, 'description' => 'The custom hostname is being configured. Try again later.'], + ['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' => '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.'], + ['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' => '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.'], + ['code' => 'ForbidUpdateSite.ConfigurationsUnclosed', 'message' => 'If there are unclosed configurations, please close them before migrating.', 'http_code' => 400, 'description' => 'If there are unclosed configurations, please close them before migrating.'], + ['code' => 'ForbidUpdateSite.PlanUnallowed', 'message' => 'Site migration between preset plans and customized enterprise plans is not supported.', 'http_code' => 400, 'description' => 'Site migration between preset plans and customized enterprise plans is not supported.'], + ['code' => 'SiteFunction.WafPageNotExist', 'message' => 'The custom page referenced in the custom response code configuration does not exist.', 'http_code' => 400, 'description' => 'The custom page referenced in the custom response code configuration does not exist.'], + ['code' => 'InvalidParameter_SchemaId', 'message' => 'The parameter SchemaId is invalid.', 'http_code' => 400, 'description' => 'The parameter SchemaId is invalid.'], + ['code' => 'InvalidParameter_IdentifierId', 'message' => 'The parameter Identified is invalid.', 'http_code' => 400, 'description' => 'The parameter Identified is invalid.'], + ['code' => 'InvalidParameter_SchemaNotFound', 'message' => 'The parameter schemaId conf not found.', 'http_code' => 400, 'description' => 'The schema configuration corresponding to the input schemaId is not found.'], + ['code' => 'InvalidParameter.ApiShieldQuota', 'message' => 'This site does not have permission to manipulate API security features.', 'http_code' => 400, 'description' => 'This site does not have permission to manipulate API security features'], + ['code' => 'InvalidParameter.RuleName', 'message' => 'The parameter RuleName is invalid.', 'http_code' => 400, 'description' => 'The parameter RuleName is invalid.'], + ['code' => 'InvalidParameter.EndpointIds', 'message' => 'The parameter EndpointIds is invalid.', 'http_code' => 400, 'description' => 'The entry EndpointIds is illegal.'], + ['code' => 'InvalidParameter.TokenConfigs', 'message' => 'The parameter TokenConfigs is invalid.', 'http_code' => 400, 'description' => 'The TokenConfigs parameter is invalid.'], + ['code' => 'InvalidParameter.TokenConfigs.Tag', 'message' => 'The parameter TokenConfigs.Tag is invalid.', 'http_code' => 400, 'description' => 'The parameter TokenConfigs_Tag is invalid.'], + ['code' => 'InvalidParameter.RuleId', 'message' => 'The parameter RuleId is invalid.', 'http_code' => 400, 'description' => 'The parameter RuleId is invalid'], + ['code' => 'InvalidParameter.IdentifierId', 'message' => 'The parameter IdentifierId is invalid.', 'http_code' => 400, 'description' => 'The parameter IdentifierId is invalid.'], + ['code' => 'SameNameRecordExceedLimit', 'message' => 'The number of records with the same name exceeds the upper limit.', 'http_code' => 400, 'description' => 'The number of records with the same name exceeds the upper limit.'], + ['code' => 'InvalidParameter.RuleAction', 'message' => 'The parameter RuleAction is invalid.', 'http_code' => 400, 'description' => 'The parameter RuleAction is invalid.'], + ['code' => 'InvalidParameter.TokenValidateType', 'message' => 'The parameter TokenValidateType is invalid.', 'http_code' => 400, 'description' => 'The parameter TokenValidateType is invalid.'], + ['code' => 'InvalidParameter.TokenName', 'message' => 'The parameter TokenName is invalid.', 'http_code' => 400, 'description' => 'The parameter TokenName is invalid.'], + ['code' => 'InvalidParameter.ManagedApi.StateCanNotChanged', 'message' => 'The status of the managed API is not allowed to be modified.', 'http_code' => 400, 'description' => 'The status of the managed API is not allowed to be modified.'], + ['code' => 'InvalidParameter.TokenNameExists', 'message' => 'The parameter TokenName already exists.', 'http_code' => 400, 'description' => 'The parameter TokenName already exists.'], + ['code' => 'InvalidParameter.Identifier.Quota', 'message' => 'The session identifier quota for the corresponding tier at the request site is insufficient.', 'http_code' => 400, 'description' => 'The session identifier quota for the corresponding tier at the request site is insufficient.'], + ['code' => 'InvalidParameter.Credentials.Alg', 'message' => 'The internal Alg field of the input parameter Credentials is invalid.', 'http_code' => 400, 'description' => 'The internal Alg field of the input parameter Credentials is invalid.'], + ['code' => 'InvalidParameter.TokenUsed', 'message' => 'The parameter TokenId token configuration is in use.', 'http_code' => 400, 'description' => 'The parameter TokenId token configuration is in use.'], + ['code' => 'InvalidParameter.ManagedApi.Quota', 'message' => 'The management API quota of the corresponding package of the request site exceeds the limit.', 'http_code' => 400, 'description' => 'The management API quota of the corresponding package of the request site exceeds the limit.'], + ['code' => 'InvalidParameter.Position', 'message' => 'The parameter Position is invalid.', 'http_code' => 400, 'description' => 'The parameter Position is invalid.'], + ['code' => 'InvalidParameter.TokenId', 'message' => 'The parameter TokenId is invalid.', 'http_code' => 400, 'description' => 'The parameter TokenId is invalid.'], + ['code' => 'InvalidParameter.Credentials', 'message' => 'The parameter Credentials is invalid.', 'http_code' => 400, 'description' => 'The parameter Credentials is invalid.'], + ['code' => 'InvalidParameter.Credentials.KidRepeat', 'message' => 'The internal field Kid of the input parameter Credentials is duplicate.', 'http_code' => 400, 'description' => 'The internal field Kid of the input parameter Credentials is duplicate.'], + ['code' => 'InvalidParameter.Credentials.Kid', 'message' => 'The internal field Kid of the input parameter Credentials is configured to be empty.', 'http_code' => 400, 'description' => 'The internal field Kid of the input parameter Credentials is configured to be empty.'], + ['code' => 'InvalidParameter.TokenSources.Repeated', 'message' => 'The input parameter TokenSources internal field configuration is duplicate.', 'http_code' => 400, 'description' => 'The input parameter TokenSources internal field configuration is duplicate.'], + ['code' => 'InvalidParameter.TokenSources.Empty', 'message' => 'The internal field of the input TokenSources is invalid.', 'http_code' => 400, 'description' => 'The internal field of the input TokenSources is invalid.'], + ['code' => 'InvalidParameter.TokenSources', 'message' => 'The parameter TokenSources is invalid.', 'http_code' => 400, 'description' => 'The parameter TokenSources is invalid.'], + ['code' => 'InvalidParameter.TokenType', 'message' => 'The parameter TokenType is invalid.', 'http_code' => 400, 'description' => 'The parameter TokenType is invalid.'], + ['code' => 'InvalidParameter.SourceIpInBlacklist', 'message' => 'The provided source is an invalid private IP address. Please verify and resubmit.', 'http_code' => 400, 'description' => 'The provided source is an invalid private IP address. Please verify and resubmit.'], + ['code' => 'InvalidParameter.PrivateIpAsSourceUnsupported', 'message' => 'The provided source is an invalid private IP address. Please verify and resubmit.', 'http_code' => 400, 'description' => 'The provided source is an invalid private IP address. Please verify and resubmit.'], + ['code' => 'InvalidParameter.PrivateIpAsSourceUnsupported', 'message' => 'The provided origin is an invalid private IP address. Please verify and resubmit.', 'http_code' => 400, 'description' => 'The provided origin is an invalid private IP address. Please verify and resubmit.'], + ['code' => 'InvalidParameter.SourceIpInBlacklist', 'message' => 'The provided origin is an invalid private IP address. Please verify and resubmit.', 'http_code' => 400, 'description' => 'The provided origin is an invalid private IP address. Please verify and resubmit.'], + ['code' => 'InvalidParameter.ManagedApi.NotChanged', 'message' => 'The status of the managed API is not allowed to be modified.', 'http_code' => 400, 'description' => 'The status of the managed API is not allowed to be modified.'], + ['code' => 'InvalidParameter.ManagedApi.Quota', 'message' => 'The API management quota of the corresponding package of the request site is insufficient.', 'http_code' => 400, 'description' => 'The API management quota of the corresponding package of the request site is insufficient.'], + ['code' => 'InvalidParameter.Position', 'message' => 'The input parameter Position is invalid.', 'http_code' => 400, 'description' => 'The input parameter Position is invalid.'], + ['code' => 'InvalidParameter.ApiActions', 'message' => 'The input parameter ApiActions is invalid.', 'http_code' => 400, 'description' => 'The input parameter ApiActions is invalid.'], + ['code' => 'InvalidParameter.ApiRule.Quota', 'message' => 'The API rule quota of the corresponding package of the request site is insufficient.', 'http_code' => 400, 'description' => 'The API rule quota of the corresponding package of the request site is insufficient.'], + ['code' => 'InvalidParameter.RuleNameExists', 'message' => 'The input parameter RuleName is duplicated.', 'http_code' => 400, 'description' => 'The input parameter RuleName is duplicated.'], + ['code' => 'InvalidParameter.Token.Quota', 'message' => 'The session token quota for the corresponding tier at the request site is insufficient.', 'http_code' => 400, 'description' => 'The session token quota for the corresponding tier at the request site is insufficient.'], + ['code' => 'AmountExceed.Entranceplan', 'message' => 'The parameter Amount exceeds the number of entrance plan that can be purchased.', 'http_code' => 400, 'description' => 'The parameter Amount exceeds the number of free versions that can be purchased.'], + ['code' => 'FreePlanOrderUnpaid', 'message' => 'Please complete your pending order for the free plan.', 'http_code' => 400, 'description' => 'Please complete your pending order for the free plan.'], + ['code' => 'QuotaExceed.FreePlan', 'message' => 'Your account has reached the maximum allowed quota for free plan purchases.', 'http_code' => 400, 'description' => 'Your account has reached the maximum allowed quota for free plan purchases.'], + ['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' => 'Illegal host record character. Only lowercase a-z, uppercase A- Z, digits 0-9, \'-\', \'_\', \'.\', \'*\', and \'@\' are supported as valid characters in host records \',\' @ \'.'."\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' => 'When you create or edit a CAA record, if the Tag is `iodef` and the Value starts with `http://` or `https://`, it must be followed by a valid URL.'], + ['code' => 'IPA.FunctionConflict', 'message' => 'KeepAliveProtection is conflicted with StaticIp and CrossBorderOptimization are conflict, can not open at same time.', 'http_code' => 400, 'description' => 'KeepAliveProtection is conflicted with StaticIp and CrossBorderOptimization are conflict, can not open at same time'], + ['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 protection specifications for mainland China and non-mainland China cannot be used as basic protection.'], + ['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' => 'The site has one or more IPA apps with keep-alive-protection enabled, so it cannot update the coverage or the instance.'], + ['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' => '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."'], + ['code' => 'IPA.KeepAliveProtectionConflict', 'message' => 'KeepAliveProtection is conflicted with StaticIp and CrossBorderOptimization, can not open at same time.', 'http_code' => 400, 'description' => 'KeepAliveProtection is conflicted with StaticIp and CrossBorderOptimization, can not open at same time'], + ['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' => 'You have an unpaid ESA order. Please complete or void the order at the User Center before placing another order.'], + ['code' => 'InvalidParameter.ApiShieldSellVerison', 'message' => 'The site does not have permissions to manipulate the enterprise-level capabilities of API security features.', 'http_code' => 400, 'description' => 'The site does not have permissions to manipulate the enterprise-level capabilities of API security features.'], + ['code' => 'SiteHasCrossBorderOptimization', 'message' => 'Chinese Mainland Network is enabled for this site. Please disable Chinese Mainland Network and try again.', 'http_code' => 400, 'description' => 'Network acceleration in mainland China is enabled for this site. Turn off network acceleration in mainland China and try again.'], + ['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' => '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.'], + ['code' => 'SiteHasCustomPorts', 'message' => 'Custom ports is enabled for this site. Please disable custom ports and try again.', 'http_code' => 400, 'description' => 'A custom port has been opened in the site. Close the custom port and try again.'], + ['code' => 'FunctionArgError', 'message' => 'Failed to check the configured function parameters.', 'http_code' => 400, 'description' => 'Failed to check the configured function parameters'], + ['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' => 'The ER build task does not exist or does not match the user, please check that it is correct and try again.'], + ['code' => 'OriginPool.TypeNotSupport', 'message' => 'The origin address pool type is not supported.', 'http_code' => 400, 'description' => 'The origin address pool type is not supported.'], + ['code' => 'Site.NotActive', 'message' => 'The status of the applied site or site is not activated.', 'http_code' => 400, 'description' => 'The status of the applied site or site is not activated.'], + ['code' => 'CustomHostname.ApplyCertFailed', 'message' => 'Fail to apply a free cert for custom hostname. Please try again later.', 'http_code' => 400, 'description' => 'Fail to apply a free cert for custom hostname. Please try again later.'], + ['code' => 'CustomHostname.SetCertFailed', 'message' => 'Fail to deploy a cert for custom hostname. Please try again later.', 'http_code' => 400, 'description' => 'Fail to deploy a cert for custom hostname. Please try again later.'], + ['code' => 'ConfigNotFound', 'message' => 'The specified configuration does not exist.', 'http_code' => 400, 'description' => 'The specified configuration does not exist.'], + ['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' => 'The ER build task does not exist or does not match the user, please check that it is correct and try again.'], + ['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' => 'The current package does not support configuring custom ports. Please check the package description and upgrade your package.'], + ['code' => 'CustomHostname.CheckQuotaFailed', 'message' => 'Fail to check quota for custom hostname. Please try again later.', 'http_code' => 400, 'description' => 'Failed to check the custom hostname quota for the site. Try again later.'], + ['code' => 'InvalidParameter.Port', 'message' => 'Invalid port. Enter a valid port as required by the interface documentation.', 'http_code' => 400, 'description' => 'Invalid port. Enter a valid port as required by the interface documentation.'], + ['code' => 'CustomHostname.OfflineForMultiReason', 'message' => 'Unable to activate the custom hostname because it is offline due to multiple reasons.', 'http_code' => 400, 'description' => 'The custom hostname has been taken offline for multiple reasons and cannot be activated.'], + ['code' => 'Site.QuotaFull', 'message' => 'The instance site count quota is full.', 'http_code' => 400, 'description' => 'The instance site count quota is full.'], + ['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' => 'The number of recorded ports exceeds the limit, including 80 or 443 ports. A maximum of 21 ports are supported. Please adjust and try again.'], + ['code' => 'CustomHostname.QueryCasCertFailed', 'message' => 'Fail to query CAS certificate details. Please try again later.', 'http_code' => 400, 'description' => 'Failed to query the China Shield certificate details. Try again later.'], + ['code' => 'CustomHostname.WildcardDomainRequireEnterprisePlan', 'message' => 'Wildcard custom hostnames require an Enterprise plan.', 'http_code' => 400, 'description' => 'Only the Enterprise plan supports adding wildcard SaaS domain names. Upgrade your plan and try again.'], + ['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' => '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.'], + ['code' => 'Ato.ApiAsset.NotExist', 'message' => 'The specified ATO API asset does not exist.', 'http_code' => 400, 'description' => 'The specified account security API asset does not exist in the current context or system configuration. Please confirm the existence of the API asset identifier and make sure it is properly defined or implemented.'], + ['code' => 'Ato.ProtectionStrategy.NotExist', 'message' => 'The specified ATO protection strategy does not exist.', 'http_code' => 400, 'description' => 'The specified account security policy does not exist in the current context or system configuration. Verify the existence of the protection policy identifier and ensure that it has been properly defined or implemented.'], + ['code' => 'Ato.ProtectionStrategy.BeingBound', 'message' => 'The specified ATO protection strategy is being bound.', 'http_code' => 400, 'description' => 'the specified account security policy is bound by one or more protection rules.'], + ['code' => 'Site.HasStaticIP', 'message' => 'This operation is not allowed because the site has static IP enabled.', 'http_code' => 400, 'description' => 'This operation is not allowed because the site has static IP enabled.'], + ['code' => 'NotEnoughResource.CustomPort', 'message' => 'Resource verification failed because there are not enough IP resources.', 'http_code' => 400, 'description' => 'Resource verification failed because there are not enough IP resources.'], + ['code' => 'Site.HasCN2', 'message' => 'The website has enabled CN2, and this operation is not allowed.', 'http_code' => 400, 'description' => 'Network access optimization in mainland China is enabled for this site. This operation is not allowed.'], + ['code' => 'Ato.ApiAsset.AlreadyBound', 'message' => 'The specified ATO API asset already bound by another rule.', 'http_code' => 400, 'description' => 'The specified ATO API asset is already bound by another rule.'], + ['code' => 'Site.HasIpaEnableKeepAliveProtection', 'message' => 'The site has one or more TCP/UDP proxied applications with keep-alive-protection enabled. Its acceleration region or plan can\'t be edited.', 'http_code' => 400, 'description' => 'The site has one or more TCP/UDP proxied applications with keep-alive-protection enabled. Its acceleration region or plan can\'t be edited.'], + ['code' => 'IPA.CanNotEnableKeepAliveProtection', 'message' => 'The site has one or more TCP/UDP proxied applications with keep-alive-protection enabled. Its acceleration region or plan can\'t be edited.', 'http_code' => 400, 'description' => 'DDoS protection for Chinese mainland or outside the Chinese mainland can\'t be "Basic protection"'], + ['code' => 'ProjectAccessDenied', 'message' => 'You do not have access to this project.', 'http_code' => 400, 'description' => 'You do not have permission to access this item.'], + ['code' => 'AIGWService.HasOpened', 'message' => 'Your AI gateway service has opened.', 'http_code' => 400, 'description' => 'You have already activated the AI gateway service and do not need to activate it again.'], + ['code' => 'NotInternationRealIdentity', 'message' => 'Real-name registration is required for services offered in Mainland China.', 'http_code' => 400, 'description' => 'You have not passed real-name verification. According to the regulations issued by MIIT, you must pass real-name verification if you want to purchase information services in the Chinese mainland.'], + ['code' => 'Page.Site.AleadyBound', 'message' => 'The specified site has already been associated with another custom error page of the same type. Dissociate the site from the existing page and try again.', 'http_code' => 403, 'description' => 'The specified site has already been associated with another custom error page of the same type. Dissociate the site from the existing page and try again.'], + ['code' => 'Page.SiteAlreadyBound', 'message' => 'The specified site has already been associated with another custom error page of the same type. Dissociate the site from the existing page and try again.', 'http_code' => 403, 'description' => 'The specified site is already bound to another custom response page of the same type. Please first unbind the site from the existing page and then try again.'], + ['code' => 'NotInternationalRealIdentity', 'message' => 'Real-name registration is required for services offered in Mainland China.', 'http_code' => 400, 'description' => 'You have not passed real-name verification. According to the regulations issued by MIIT, you must pass real-name verification if you want to purchase information services in the Chinese mainland.'], + ['code' => 'InvalidParameter_ApiRuleId', 'message' => 'A rule configuration exists for the requested API. Delete the relevant API rule configuration before deleting the corresponding API.', 'http_code' => 400, 'description' => 'A rule configuration exists for the requested API. Delete the relevant API rule configuration before deleting the corresponding API.'], + ['code' => 'InvalidParameter_ApiSchemaId', 'message' => 'The requested Api has a schema validation configuration. Delete the schema validation configuration before deleting the corresponding Api.', 'http_code' => 400, 'description' => 'The requested Api has a schema validation configuration. Delete the schema validation configuration before deleting the corresponding Api.'], + ['code' => 'InvalidParameter_ApiIdentifierId', 'message' => 'The Api to be deleted has a session identifier configuration. Delete the session identifier configuration before deleting the corresponding Api.', 'http_code' => 400, 'description' => 'The Api to be deleted has a session identifier configuration. Delete the session identifier configuration before deleting the corresponding Api.'], + ['code' => 'InvalidParameter.ApiShieldSellVersion', 'message' => 'The site does not have permissions to manipulate the enterprise-level capabilities of API security features.', 'http_code' => 400, 'description' => 'The site does not have permissions to manipulate the enterprise-level capabilities of API security features.'], + ['code' => 'Record.RecordNameConflictWithDSName', 'message' => 'The record name cannot have the same name as the DS type record.', 'http_code' => 400, 'description' => 'When you create or edit DNS record information, the record name cannot be the same as the DS record name.'], + ['code' => 'Record.RecordNameConflictWithEdgeFunctionRoutineRecordName', 'message' => 'The record name cannot have the same name as the Routine inner type record name in Edge Function.', 'http_code' => 400, 'description' => 'When creating or editing DNS record information, the record name cannot be the same as the record name in Edge Function (Routine).'], + ['code' => 'OriginPool.CheckQuotaFailed', 'message' => 'Failed to check source pool quota for site, please try again later.', 'http_code' => 400, 'description' => 'Failed to check source pool quota for site, please try again later.'], + ['code' => 'CustomHostname.InvalidStatus', 'message' => 'The status of the custom hostname you configured is invalid, and this operation cannot be performed. Please check the status of the custom hostname and try again.', 'http_code' => 400, 'description' => 'The status of the custom hostname you configured is invalid, and this operation cannot be performed. Please check the status of the custom hostname and try again.'], + ['code' => 'InvalidParameter.StartEndTimeErr', 'message' => 'There is a logic error in the time-related field of the request input parameter.', 'http_code' => 400, 'description' => 'There is a logic error in the time-related field of the request input parameter.'], + ['code' => 'InvalidParameter.ApiShieldRiskDetectionPolicyConfigurationQuota', 'message' => 'This site does not have permissions to view API security risk detection and policy management.', 'http_code' => 400, 'description' => 'This site does not have permissions to view API security risk detection and policy management.'], + ['code' => 'InvalidParameter.RulesFormat', 'message' => 'The input rules format specification of the request does not meet the requirements.', 'http_code' => 400, 'description' => 'The input rules format specification of the request does not meet the requirements.'], + ['code' => 'InvalidParameter.RuleCountExceedsLimit', 'message' => 'The number of API security policy rules created exceeds the limit.', 'http_code' => 400, 'description' => 'The number of API security policy rules created exceeds the limit.'], + ['code' => 'InvalidParameter.AbnormalLevel', 'message' => 'The request input parameter AbnormalLevel field is invalid.', 'http_code' => 400, 'description' => 'The request input parameter AbnormalLevel field is invalid.'], + ['code' => 'InvalidParameter.StatusList', 'message' => 'The request input parameter StatusList field is invalid.', 'http_code' => 400, 'description' => 'The request input parameter StatusList field is invalid.'], + ['code' => 'InvalidParameter.ApiTag', 'message' => 'The request input parameter ApiTag field is invalid.', 'http_code' => 400, 'description' => 'The request input parameter ApiTag field is invalid.'], + ['code' => 'InvalidParameter.EndTime', 'message' => 'The format of the EndTime-related fields in the request parameters is invalid.', 'http_code' => 400, 'description' => 'The format of the EndTime-related fields in the request parameters is invalid.'], + ['code' => 'InvalidParameter.StartTime', 'message' => 'The format of the StartTime-related fields in the request parameters is invalid.', 'http_code' => 400, 'description' => 'The format of the StartTime-related fields in the request parameters is invalid.'], + ['code' => 'InvalidParameter.StartEndTimeErr', 'message' => 'The logic of the request input start and end time is unreasonable.', 'http_code' => 400, 'description' => 'The logic of the request input start and end time is unreasonable.'], + ['code' => 'PaidCrawling.Disabled', 'message' => 'Paid crawling feature is not enabled, cannot set action to paid crawling.', 'http_code' => 403, 'description' => 'Paid crawling feature is not enabled, cannot set action to paid_crawling.'], + ['code' => 'PaidCrawling.InUse', 'message' => 'Cannot disable paid crawling while existing rules still reference it.', 'http_code' => 403, 'description' => 'When there is a rule that uses a paid crawl action, the paid crawl setting cannot be turned off.'], + ['code' => 'ErrorRedemptionCodeNotInvalidDomain', 'message' => 'The domain is invalid.', 'http_code' => 400, 'description' => 'The domain name is illegal.'], + ['code' => 'ErrorRedemptionCodeDomainInEsa', 'message' => 'Domain already in ESA in the last 30 days.', 'http_code' => 400, 'description' => 'The domain name has been connected to the ESA in the last 30 days.'], + ['code' => 'ErrorRedemptionCodeNotRootDomain', 'message' => 'The domain name is not a root domain name.', 'http_code' => 400, 'description' => 'The domain name is not a root domain name.'], + ['code' => 'ErrorRedemptionCodeNocodeLeft', 'message' => 'Insufficient redemption code inventory.', 'http_code' => 400, 'description' => 'Insufficient exchange code inventory'], + ['code' => 'ErrorRedemptionCodeAlreadyClaimed', 'message' => 'User already claimed a redemption code.', 'http_code' => 400, 'description' => 'This user has already received a redemption code.'], + ['code' => 'ApiShiled.Identifier.Existed', 'message' => 'Duplicate request Identifier related configuration.', 'http_code' => 400, 'description' => 'Duplicate request Identifier related configuration.'], + ['code' => 'ApiShiled.Identifier.JwtName', 'message' => 'The request input parameter JwtName field is invalid.', 'http_code' => 400, 'description' => 'The request input parameter JwtName field is invalid.'], + ['code' => 'ApiShiled.Identifier.CookieName', 'message' => 'The request input parameter CookieName field is invalid.', 'http_code' => 400, 'description' => 'The request input parameter CookieName field is invalid.'], + ['code' => 'ApiShiled.Identifier.HeaderName', 'message' => 'The request input parameter headerName field is invalid.', 'http_code' => 400, 'description' => 'The request input parameter headerName field is invalid.'], + ['code' => 'ApiShiled.Identifier.JwtTokenId', 'message' => 'The request input parameter JwtTokenId field is invalid.', 'http_code' => 400, 'description' => 'The request input parameter JwtTokenId field is invalid.'], + ['code' => 'ApiShield.SchemaData.Version', 'message' => 'The request input SchemaData content openapi field is illegal.', 'http_code' => 400, 'description' => 'The request input SchemaData content openapi field is illegal.'], + ['code' => 'ApiShield.SchemaData.Method', 'message' => 'The method field of the request input parameter SchemaData is invalid.', 'http_code' => 400, 'description' => 'The method field of the request input parameter SchemaData is invalid.'], + ['code' => 'ApiShield.SchemaFile.Quota', 'message' => 'The quota of schema files for the package API security function of the request site is insufficient.', 'http_code' => 400, 'description' => 'The quota of schema files for the package API security function of the request site is insufficient.'], + ['code' => 'ApiShield.SchemaData.Api', 'message' => 'The request input parameter SchemaData content API field is invalid.', 'http_code' => 400, 'description' => 'The request input parameter SchemaData content API field is invalid.'], + ['code' => 'ApiShield.SchemaData', 'message' => 'The request input SchemaData field is invalid.', 'http_code' => 400, 'description' => 'The request input parameter SchemaData field is invalid.'], + ['code' => 'ApiShield.SchemaData.Host', 'message' => 'The request input parameter SchemaData content host field is illegal.', 'http_code' => 400, 'description' => 'The request input parameter SchemaData content host field is illegal.'], + ['code' => 'InvalidParameter.TokenSourcesRepeated', 'message' => 'Duplicate configurations are not allowed in the input TokenSources.', 'http_code' => 400, 'description' => 'Duplicate configurations are not allowed in the input TokenSources.'], + ['code' => 'InvalidParameter.TokenConfigs.Id', 'message' => 'The internal Id field of the input TokenConfigs array is invalid.', 'http_code' => 400, 'description' => 'The internal Id field of the input TokenConfigs array is invalid.'], + ['code' => 'RealTimeLog.S3AccessDenied', 'message' => 'The permissions check for the S3 address you posted failed.', 'http_code' => 400, 'description' => 'The permissions check for the S3 address you posted failed.'], + ], + 'changeSet' => [ [ - 'code' => '%s.NotSupport', - 'message' => 'The specified resource type %s is not supported.', - 'http_code' => 403, - 'description' => 'The specified resource type is not supported. To use this type of resource, please contact us.', - ], - [ - 'code' => '%s.OverQuota', - 'message' => 'The quantity of %s exceeds the quota.', - 'http_code' => 403, - 'description' => 'The amount of this resource exceeds the quota. If you need to apply for more quota, please contact us.', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'SetClientCertificateHostnames'], + ], + 'createdAt' => '2025-03-13T09:11:33.000Z', + 'description' => '', ], [ - 'code' => '%s.WrongValueMatched', - 'message' => 'The value of specified parameter %s can not pass the matching check.', - 'http_code' => 403, - 'description' => 'The value of the specified parameter can not pass the matching check. If you determine that you need to use this parameter value, please contact us.', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListScheduledPreloadJobs'], + ], + 'createdAt' => '2025-03-13T08:02:30.000Z', + 'description' => '', ], [ - 'code' => 'AccountBlacklist', - 'message' => 'Account blacklist restrictions, please submit a work order to contact customer service for processing.', - 'http_code' => 400, - 'description' => 'Account blacklist restrictions, please submit a work order to contact customer service for processing.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'BlockObject'], + ['description' => 'Error codes changed', 'api' => 'PreloadCaches'], + ['description' => 'Error codes changed', 'api' => 'PurgeCaches'], + ], + 'createdAt' => '2025-03-13T07:59:15.000Z', + 'description' => '', ], [ - 'code' => 'AccountStatusIllegal', - 'message' => 'The account status is illegal.', - 'http_code' => 400, - 'description' => 'The account status is illegal.', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetClientCaCertificate'], + ['description' => 'Response parameters changed', 'api' => 'GetClientCertificate'], + ['description' => 'Response parameters changed', 'api' => 'ListClientCaCertificates'], + ['description' => 'Response parameters changed', 'api' => 'ListClientCertificates'], + ], + 'createdAt' => '2025-03-12T03:31:00.000Z', + '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' => 'Failed to match an active website based on the hostname you specified. Check whether the hostname is correct or activate the website first.', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateCustomScenePolicy'], + ], + 'createdAt' => '2025-03-12T02:37:17.000Z', + 'description' => '', ], [ - 'code' => 'AppAlreadyExist', - 'message' => 'The containerized application name already exists. Specify another name.', - 'http_code' => 400, - 'description' => 'The containerized application name already exists. Specify another name.', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateSiteDeliveryTask'], + ], + 'createdAt' => '2025-02-28T07:45:05.000Z', + 'description' => '', ], [ - 'code' => 'ApplyCertificateNotAllowed', - 'message' => 'The certificate application is not allowed for current site.', - 'http_code' => 400, - 'description' => 'The current site is not allowed to request a free certificate, please make sure the site is activated. To apply for a wildcard domain name certificate, make sure that the current site is accessed in NS mode.', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateOriginRule'], + ['description' => 'Response parameters changed', 'api' => 'GetOriginRule'], + ['description' => 'Response parameters changed', 'api' => 'ListOriginRules'], + ['description' => 'Request parameters changed', 'api' => 'UpdateOriginRule'], + ], + 'createdAt' => '2025-02-27T09:17:23.000Z', + 'description' => '', ], [ - 'code' => 'ApplyVanityNSError', - 'message' => 'Failed to apply for vanity NS resources. Please contact customer service.', - 'http_code' => 400, - 'description' => 'Failed to apply for vanity NS resources. Please contact customer service.', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetWafFilter'], + ], + 'createdAt' => '2025-02-27T08:45:59.000Z', + 'description' => '', ], [ - 'code' => 'ApplyVipError', - 'message' => 'Failed to apply for ip resources, please contact customer service.', - 'http_code' => 400, - 'description' => 'Failed to apply for IP resources, please contact customer service.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DeleteOriginProtection'], + ['description' => 'Error codes changed', 'api' => 'UpdateOriginProtection'], + ['description' => 'Error codes changed', 'api' => 'UpdateOriginProtectionIpWhiteList'], + ], + 'createdAt' => '2025-02-21T06:59:44.000Z', + 'description' => '', ], [ - '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' => 'The current plan does not support the configuration of restricted parameters, please check the input parameters.', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateWaitingRoomEvent'], + ['description' => 'Request parameters changed', 'api' => 'UpdateWaitingRoomRule'], + ], + 'createdAt' => '2025-02-21T03:41:24.000Z', + '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' => 'You have not completed your basic personal information. Please complete the information and re-operate. (If the current account is a managed sub-account, please contact the main account and click this link to complete the information.) <"/>esarealtimelogpushsls.dcdnservices.aliyuncs.com<"/><"/>.', - 'http_code' => 400, - 'description' => 'You do not have permissions to create a service-linked role.Contact your account administrator to attach the AliyunESAFullAccess policy or a custom policy that grants permissions to create a service-linked role to the current user.Service: <"/><"/>esarealtimelogpushsls.dcdnservices.aliyuncs.com<"/><"/>.', - ], - [ - 'code' => 'CreateTimeError', - 'message' => 'The effective time of the same policy template cannot overlap.', - 'http_code' => 400, - 'description' => 'The effective time of the same policy template cannot overlap.', - ], - [ - 'code' => 'DependedByOthers', - 'message' => 'Failed to call the service. Try again later or contact technical support.', - 'http_code' => 400, - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'code' => 'DnsSecDenied', - 'message' => 'Only sites accessed by NS can enable DNSSEC.', - 'http_code' => 400, - 'description' => 'Only sites accessed by NS can enable the DNSSEC function.', - ], - [ - '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' => '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.', - ], - [ - 'code' => 'DomainInRiskList', - 'message' => 'The domain you added may be at risk. If you have any questions, please submit a ticket.', - 'http_code' => 400, - 'description' => 'The domain name you added may be at risk. If you have any questions, please submit a work order.', - ], - [ - 'code' => 'DomainNameOverLimit', - 'message' => 'A maximum of 500 domains are supported for each request.', - 'http_code' => 400, - 'description' => 'Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.', - ], - [ - 'code' => 'DuplicateRequirementTicket', - 'message' => 'Repeated demand order.', - 'http_code' => 400, - 'description' => 'Repeated demand order.', - ], - [ - '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' => 'There is overlap between multiple edge ports, please check and try again after modification.', - ], - [ - 'code' => 'EnterpriseAmountErr', - 'message' => 'Enterprise plans do not support bulk purchase.', - 'http_code' => 400, - 'description' => 'Enterprise plans do not support bulk purchase.', - ], - [ - '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' => 'This feature is unavailable because your website is not associated with an Enterprise plan. Upgrade your plan to Enterprise.', - ], - [ - 'code' => 'ErService.HasOpened', - 'message' => 'You have already activated Edge Routine.', - 'http_code' => 400, - 'description' => 'You have already activated Edge Routine.', - ], - [ - 'code' => 'ErService.NotOpen', - 'message' => 'Er service has not opend.', - 'http_code' => 403, - 'description' => 'Er service has not opend.', - ], - [ - 'code' => 'EsaService.NotOpen', - 'message' => 'ESA service has not opend.', - 'http_code' => 403, - 'description' => 'Edge Security Accelerator (ESA) is not turned on', - ], - [ - 'code' => 'ExceedFileUpload', - 'message' => 'The size of the uploaded file exceeds the upper limit. Select a file less than 10 MB.', - 'http_code' => 400, - 'description' => 'The size of the uploaded file exceeds the upper limit. Select a file less than 10 MB.', - ], - [ - 'code' => 'Expression.Invalid', - 'message' => 'Expression syntax error or data type mismatched.', - 'http_code' => 403, - 'description' => 'Expression syntax error or data type mismatched.', - ], - [ - 'code' => 'Expression.Invalid', - 'message' => 'The specified expression is invalid: %s.', - 'http_code' => 403, - 'description' => 'The specified expression is invalid.', - ], - [ - 'code' => 'Forbidden', - 'message' => 'You are not authorized to operate this resource, or this API does not support RAM.', - 'http_code' => 403, - 'description' => 'You are not authorized to operate this resource, or this API does not support RAM.', - ], - [ - 'code' => 'FunctionConflict', - 'message' => 'The feature configuration conflicts. Sites with version management enabled cannot configure this feature.', - 'http_code' => 400, - 'description' => 'The currently configured function conflicts with other functions. If you need to configure, delete the conflicting function configurations first.', - ], - [ - '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' => 'The current plan does not support the configuration of restricted functions, please check the plan related function description.', - ], - [ - 'code' => 'HostnameNumberExceedLimit', - 'message' => 'The maximum number of hostnames associated with the CA certificate you specified has been reached.', - 'http_code' => 400, - 'description' => 'The number of domain names bound to CA certificates exceeds the limit. A maximum of 50 domain names can be bound to each CA certificate.', - ], - [ - 'code' => 'Id.MissingParameter', - 'message' => 'The parameter Id is required.', - 'http_code' => 400, - 'description' => 'The required parameter Id is missing.', - ], - [ - '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' => 'The version management operation failed because incompatible features or environment settings are configured. Adjust your configurations and try again.', - ], - [ - 'code' => 'Instance.NotOnline', - 'message' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - 'http_code' => 400, - 'description' => 'Your plan is unavailable due to an overdue payment. Complete the payment first.', - ], - [ - 'code' => 'Instance.ReleaseFailed', - 'message' => 'Instance release failed.', - 'http_code' => 400, - 'description' => 'Instance release failed.', - ], - [ - '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' => 'The security instance can only be changed after 31 days of purchase, and can only be changed once a natural month.', - ], - [ - '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' => 'The instance does not exist. Check whether the specified instance ID is correct or whether the instance belongs to your account.', - ], - [ - 'code' => 'InsufficientAvailableQuota', - 'message' => 'Your account balance is insufficient.', - 'http_code' => 400, - 'description' => 'Your account is in arrears, please pay the arrears before purchasing.', - ], - [ - 'code' => 'InsufficientBalance', - 'message' => 'Your account balance is insufficient.', - 'http_code' => 400, - 'description' => 'Your account balance is insufficient, please recharge before purchasing.', - ], - [ - 'code' => 'InternalError', - 'message' => 'An internal exception occurred, please try again later.', - 'http_code' => 400, - 'description' => 'An inner exception was triggered. Please try again later.', - ], - [ - 'code' => 'InternalError', - 'message' => 'Failed to call the service. Try again later or contact technical support.', - 'http_code' => 500, - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'code' => 'InternalException', - 'message' => 'Failed to call the service. Try again later or contact technical support.', - 'http_code' => 400, - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'code' => 'InternalOperationError', - 'message' => 'Failed to call the service. Try again later or contact technical support.', - 'http_code' => 400, - 'description' => 'Failed to call the service. Try again later or contact technical support.', - ], - [ - 'code' => 'Invalid.Parameter', - 'message' => 'Invalid request parameters for querying standard logs. Check and try again.', - 'http_code' => 400, - 'description' => 'Invalid request parameters for querying standard logs. Check and try again.', - ], - [ - 'code' => 'Invalid.Value', - 'message' => 'Invalid value in the key-value pair. Make sure the value is Base64-encoded.', - 'http_code' => 400, - 'description' => 'Invalid value in the key-value pair. Make sure the value is Base64-encoded.', - ], - [ - 'code' => 'InvalidAccount.Malformed', - 'message' => 'The specified account is invalid.', - 'http_code' => 400, - 'description' => 'The account number is not entered correctly, for example, the input is empty.', - ], - [ - 'code' => 'InvalidAccount.NotFound', - 'message' => 'The specified account does not exist.', - 'http_code' => 404, - 'description' => 'The specified account does not exist.', - ], - [ - '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' => 'The application does not exist. Check whether the application ID you specified is correct and try again.', - ], - [ - 'code' => 'InvalidArgName', - 'message' => 'The parameter name does not exist, please check the function interface document.', - 'http_code' => 400, - 'description' => 'The parameter name does not exist, please check the function interface document.', - ], - [ - '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' => 'The specified certificate does not match the website. Check the validity of the certificate and try again.', - ], - [ - 'code' => 'InvalidComponent', - 'message' => 'The order parameters is invalid.', - 'http_code' => 400, - 'description' => 'The order parameters is invalid.', - ], - [ - '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' => 'The ConfigId does not exist.', - ], - [ - 'code' => 'InvalidEndTime.Malformed', - 'message' => 'The specified EndTime is invalid.', - 'http_code' => 400, - 'description' => 'Please provide the correct end time format. The date format follows ISO8601 notation and uses UTC time. The format is: yyyy-MM-ddTHH:mm:ssZ.', - ], - [ - 'code' => 'InvalidEndTime.Mismatch', - 'message' => 'The specified EndTime is earlier than the StartTime.', - 'http_code' => 400, - 'description' => 'The end time you entered is earlier than the start time. Please check and try again.', - ], - [ - 'code' => 'InvalidExecution.CountFull', - 'message' => 'The maximum number of prefetch plans has been reached. Delete some completed tasks and try again.', - 'http_code' => 400, - 'description' => 'The maximum number of prefetch plans has been reached. Delete some completed tasks and try again.', - ], - [ - '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' => 'The execution plan does not exist. Check whether the parameters such as the execution ID, start time, and end time are correct.', - ], - [ - 'code' => 'InvalidFunctions.Malformed', - 'message' => 'The specified Functions is invalid.', - 'http_code' => 400, - 'description' => 'The specified configuration is invalid.', - ], - [ - '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' => 'The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.', - ], - [ - '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' => 'The maximum number of prefetch tasks for the website has been reached. Delete some unwanted ones and try again.', - ], - [ - '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' => 'The task does not exist. Check whether the task ID is correct or whether the task has been deleted.', - ], - [ - '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' => 'The maximum storage capacity of the Edge KV namespace has been reached. Delete unwanted key-value pairs to save the storage.', - ], - [ - 'code' => 'InvalidKey.ExceedsCapacity', - 'message' => 'The maximum capacity of a single namespace cannot exceed 1 GB.', - 'http_code' => 403, - 'description' => 'The capacity of the storage space exceeds the limit.', - ], - [ - 'code' => 'InvalidKey.ExceedsMaximum', - 'message' => 'The size of the key cannot exceed 512 bytes.', - 'http_code' => 400, - 'description' => 'The length of the requested key is too large.', - ], - [ - 'code' => 'InvalidKey.Malformed', - 'message' => 'The specified key is invalid.', - 'http_code' => 400, - 'description' => 'Key name input error, such as entering an empty string.', - ], - [ - 'code' => 'InvalidKey.NotFound', - 'message' => 'The specified key does not exist.', - 'http_code' => 404, - 'description' => 'The specified key-value pair does not exist.', - ], - [ - 'code' => 'InvalidKey.QuotaFull', - 'message' => 'The total number of IP exceeds the quota.', - 'http_code' => 406, - 'description' => 'The total number of ip addresses exceeds the quota.', - ], - [ - 'code' => 'InvalidKey.TooManyDimensions', - 'message' => 'Request contains too many dimensions.', - 'http_code' => 400, - 'description' => 'Request contains too many dimensions. For more information, see OpenAPI Documentation .'."\n", - ], - [ - 'code' => 'InvalidNameSpace.Duplicate', - 'message' => 'The specified namespace already exists.', - 'http_code' => 406, - 'description' => 'Specified storage space', - ], - [ - 'code' => 'InvalidNameSpace.Malformed', - 'message' => 'The specified namespace is invalid.', - 'http_code' => 400, - 'description' => 'The bucket name is entered incorrectly, such as an empty string.', - ], - [ - 'code' => 'InvalidNameSpace.NotFound', - 'message' => 'The specified namespace does not exist.', - 'http_code' => 404, + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DeleteWaitingRoomEvent'], + ['description' => 'Request parameters changed', 'api' => 'DeleteWaitingRoomRule'], + ['description' => 'Response parameters changed', 'api' => 'ListCacheReserveInstances'], + ], + 'createdAt' => '2025-02-21T03:26:42.000Z', 'description' => '', ], [ - 'code' => 'InvalidNameSpace.QuotaFull', - 'message' => 'The maximum number of namespaces is exceeded.', - 'http_code' => 406, - 'description' => 'The number of storage spaces exceeds the capacity limit.', - ], - [ - 'code' => 'InvalidNextToken', - 'message' => 'The specified parameter NextToken is invalid.', - 'http_code' => 400, - 'description' => 'The parameter NextToken is illegal.', - ], - [ - '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' => 'The request PageSize value is invalid. The default value is 20 and the value range is 1-500.', - ], - [ - 'code' => 'InvalidParameter', - 'message' => 'Invalid parameter. Check the parameter configuration.', - 'http_code' => 400, - 'description' => 'Invalid parameter. Check the parameter configuration.', - ], - [ - 'code' => 'InvalidParameter', - 'message' => 'Parameter verification failed. Check your configurations and try again.', - 'http_code' => 400, - 'description' => 'Parameter verification failed. Check your configurations and try again.', - ], - [ - 'code' => 'InvalidParameter', - 'message' => 'The specified parameter is invalid.', - 'http_code' => 400, - 'description' => 'The specified parameter is invalid.', - ], - [ - 'code' => 'InvalidParameter.AddressConflict', - 'message' => 'Duplicate origin addresses. Make sure that each origin address for the same pool is unique.', - 'http_code' => 400, - 'description' => 'Duplicate origin addresses. Make sure that each origin address for the same pool is unique.', - ], - [ - 'code' => 'InvalidParameter.ApiItems.Api', - 'message' => 'The parameter apiItems api is invalid.', - 'http_code' => 400, - 'description' => 'The parameter apiItems api is invalid.', - ], - [ - 'code' => 'InvalidParameter.ApiItems.Host', - 'message' => 'The parameter apiItems host is invalid.', - 'http_code' => 400, - 'description' => 'The parameter apiItems host is invalid.', - ], - [ - 'code' => 'InvalidParameter.ApiShield.Quota', - 'message' => 'This website does not have the permission to view API security features.', - 'http_code' => 400, - 'description' => 'This website does not have the permission to view API security features.', - ], - [ - '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' => 'The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application 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' => 'The format of the input application ID is incorrect. You can use the ListEdgeContainerApps API to obtain the application 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' => 'Invalid ArgName. Check your website configuration parameters and make sure that they match the supported features and parameter names listed in the official documentation.', - ], - [ - 'code' => 'InvalidParameter.ArgValue', - 'message' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - 'http_code' => 400, - 'description' => 'Invalid parameter value. Check whether the value format and length meet the requirements.', - ], - [ - 'code' => 'InvalidParameter.ClientIpPassThroughMode', - 'message' => 'Invalid client IP transfer protocol, please refer to the interface document and pass in valid parameters.', - 'http_code' => 400, - 'description' => 'Invalid client IP transfer protocol, please refer to the interface document and pass in valid parameters.', - ], - [ - 'code' => 'InvalidParameter.CnameSiteRecordNoProxied', - 'message' => 'A non-proxied record was added for a website using a CNAME setup.', - 'http_code' => 400, - 'description' => 'A non-proxied record was added for a website using a CNAME setup.', - ], - [ - 'code' => 'InvalidParameter.CnameSiteRecordUnsupport', - 'message' => 'The current record type is not supported for a website connected by CNAME setup.', - 'http_code' => 400, - 'description' => 'You can only add A/AAAA and CNAME records to a website connected by CNAME setup.', - ], - [ - 'code' => 'InvalidParameter.ConfigIds', - 'message' => 'Invalid ConfigId. Specify an existing Configld and make sure it is in the valid format.', - 'http_code' => 400, - 'description' => 'Invalid ConfigId. Specify an existing Configld and make sure it is in the valid format.', - ], - [ - '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' => 'Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.', - ], - [ - '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' => 'The selected location is unavailable in your plan. Change the location to one that is covered by the plan and try again.', - ], - [ - 'code' => 'InvalidParameter.Dimension', - 'message' => 'The specified Dimension is invalid.', - 'http_code' => 400, - 'description' => 'The specified Dimension is invalid. For more information, see OpenAPI Documentation .'."\n", - ], - [ - 'code' => 'InvalidParameter.DomainNotBelongingUser', - 'message' => 'The domain name passed in does not belong to the current user.', - 'http_code' => 400, - 'description' => 'The domain name passed in does not belong to the current user.', - ], - [ - 'code' => 'InvalidParameter.Domains', - 'message' => 'Duplicate domain names are specified for parameter Domains. Remove one of them and try again.', - 'http_code' => 400, - 'description' => 'Duplicate domain names are specified for parameter Domains. Remove one of them and try again.', - ], - [ - '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' => 'The maximum number of domain names specified by parameter Domains has been reached. Adjust your configurations and try again.', - ], - [ - 'code' => 'InvalidParameter.Domains', - 'message' => 'You have already submitted a certificate application for the domain name.', - 'http_code' => 400, - 'description' => 'You have already submitted a certificate application for the domain name.', - ], - [ - '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' => 'One or more domain names specified by parameter Domains do not belong to the current website. Check and try again.', - ], - [ - '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 there is an invalid domain name in the parameter, please check and try again.', - ], - [ - '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' => 'The site you configured is currently accessed in the CNAME mode. Please switch to the NS mode and try again.', - ], - [ - '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' => '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.', - ], - [ - 'code' => 'InvalidParameter.Domains', - 'message' => 'The site which is configured in CNAME mode does not support wildcard domain certificate application.', - 'http_code' => 400, - 'description' => 'The CNAME site does not support applying for a free certificate for wildcard domain names.', - ], - [ - 'code' => 'InvalidParameter.DomainsExceedLimit', - 'message' => 'The number of incoming domain names exceeds the maximum limit.', - 'http_code' => 400, - 'description' => 'The number of incoming domain names exceeds the maximum limit.'."\n", - ], - [ - 'code' => 'InvalidParameter.DomainSourceTypeNotSupport', - 'message' => 'The underlying source type of the domain is not supported.', - 'http_code' => 400, - 'description' => 'The underlying origin type of the domain name is not supported.', - ], - [ - 'code' => 'InvalidParameter.EmptyAKSK', - 'message' => 'AK,SK information cannot be empty.', - 'http_code' => 400, - 'description' => 'AK,SK information cannot be empty.', - ], - [ - 'code' => 'InvalidParameter.EndpointId', - 'message' => 'The parameter EndpointId is invalid.', - 'http_code' => 400, - 'description' => 'The parameter EndpointId is invalid.', - ], - [ - 'code' => 'InvalidParameter.ExistedHandlingTask', - 'message' => 'There is a task in process, waiting for execution to complete.', - 'http_code' => 400, - 'description' => 'There is a task in process, waiting for execution to complete.', - ], - [ - 'code' => 'InvalidParameter.Field', - 'message' => 'The specified Field is invalid.', - 'http_code' => 400, - 'description' => 'The specified Field is invalid. For more information, see OpenAPI Documentation .', - ], - [ - 'code' => 'InvalidParameter.FunctionName', - 'message' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - 'http_code' => 400, - 'description' => 'The specified feature does not exist. Specify a valid feature name based on the related documentation.', - ], - [ - 'code' => 'InvalidParameter.FuzzySearch', - 'message' => 'The parameter fuzzySearch is invalid.', - 'http_code' => 400, - 'description' => 'The parameter fuzzySearch is invalid.', - ], - [ - 'code' => 'InvalidParameter.HealthCheckFailTimes', - 'message' => 'Specified parameter HealthCheckFailTimes is not valid.', - 'http_code' => 400, - 'description' => 'Parameter HealthCheckFailTimes format is incorrect.', + 'apis' => [ + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'PurchaseRatePlan'], + ], + 'createdAt' => '2025-02-20T05:45:43.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.HealthCheckHost', - 'message' => 'Specified parameter HealthCheckHost is not valid.', - 'http_code' => 400, - 'description' => 'Parameter HealthCheckHost format is incorrect.', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeCustomScenePolicies'], + ], + 'createdAt' => '2025-02-19T08:09:11.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.HealthCheckHttpCode', - 'message' => 'Specified parameter HealthCheckHttpCode is not valid.', - 'http_code' => 400, - 'description' => 'Parameter HealthCheckHttpCode format is incorrect.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'BatchCreateRecords'], + ['description' => 'Error codes changed', 'api' => 'CreateRecord'], + ['description' => 'Response parameters changed', 'api' => 'GetSite'], + ['description' => 'Response parameters changed', 'api' => 'ListSites'], + ], + 'createdAt' => '2025-02-18T05:59:56.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.HealthCheckInterval', - 'message' => 'Specified parameter HealthCheckInterval is not valid.', - 'http_code' => 400, - 'description' => 'Parameter HealthCheckInterval format is incorrect.', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SetCertificate'], + ], + 'createdAt' => '2025-02-13T01:37:48.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.HealthCheckMethod', - 'message' => 'Specified parameter HealthCheckMethod is not valid.', - 'http_code' => 400, - 'description' => 'Parameter HealthCheckMethod format is incorrect.', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateLoadBalancer'], + ['description' => 'Response parameters changed', 'api' => 'ListLoadBalancers'], + ['description' => 'Request parameters changed', 'api' => 'UpdateLoadBalancer'], + ], + 'createdAt' => '2025-02-13T01:35:09.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.HealthCheckPort', - 'message' => 'Specified parameter HealthCheckPort is not valid.', - 'http_code' => 400, - 'description' => 'Parameter HealthCheckPort format is incorrect.', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateCompressionRule'], + ['description' => 'Response parameters changed', 'api' => 'GetCompressionRule'], + ['description' => 'Response parameters changed', 'api' => 'ListCompressionRules'], + ['description' => 'Request parameters changed', 'api' => 'UpdateCompressionRule'], + ], + 'createdAt' => '2025-02-12T02:26:24.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.HealthCheckSuccTimes', - 'message' => 'Specified parameter HealthCheckSuccTimes is not valid.', - 'http_code' => 400, - 'description' => 'Parameter HealthCheckHost format is incorrect.', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateWaitingRoom'], + ['description' => 'Response parameters changed', 'api' => 'CreateWaitingRoomEvent'], + ['description' => 'Response parameters changed', 'api' => 'CreateWaitingRoomRule'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListUserRatePlanInstances'], + ], + 'createdAt' => '2025-02-12T02:01:47.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.HealthCheckTimeout', - 'message' => 'Specified parameter HealthCheckTimeout is not valid.', - 'http_code' => 400, - 'description' => 'Parameter HealthCheckTimeout format is incorrect.', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribePurgeTasks'], + ['description' => 'Request parameters changed', 'api' => 'GetPurgeQuota'], + ['description' => 'Request parameters changed', 'api' => 'PurgeCaches'], + ], + 'createdAt' => '2025-02-10T01:56:01.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.HealthCheckType', - 'message' => 'Specified parameter HealthCheckType is not valid.', - 'http_code' => 400, - 'description' => 'Parameter HealthCheckType format is incorrect.', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateLoadBalancer'], + ], + 'createdAt' => '2025-02-10T01:26:43.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.HealthCheckURI', - 'message' => 'Specified parameter HealthCheckURI is not valid.', - 'http_code' => 400, - 'description' => 'Parameter HealthCheckURI format is incorrect.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DeleteSite'], + ['description' => 'Response parameters changed', 'api' => 'ListUserRatePlanInstances'], + ], + 'createdAt' => '2025-01-10T01:52:00.000Z', + 'description' => '', ], [ - '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' => 'The HttpHeaders parameter is invalid. Please check whether the HttpHeaders parameter is filled in. The parameter cannot contain @.', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListPages'], + ], + 'createdAt' => '2025-01-09T06:25:18.000Z', + 'description' => '', ], [ - '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' => 'Illegal Image parameter. Please check the Image parameter, which cannot be assigned to illegal characters such @.', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'SetCertificate'], + ], + 'createdAt' => '2025-01-09T05:45:30.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.InvalidBiz', - 'message' => 'the value of the business type is empty or the incoming parameter is invalid.', - 'http_code' => 400, - 'description' => 'The value of the business type is empty or the incoming parameter is invalid.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ListManagedRulesGroups'], + ['description' => 'Request parameters changed', 'api' => 'UpdatePage'], + ], + 'createdAt' => '2024-12-26T15:08:05.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.InvalidBiz', - 'message' => 'The incoming parameter value of the business type is empty or incorrect.', - 'http_code' => 400, - 'description' => 'The incoming parameter value of the business type is empty or incorrect.', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateUserDeliveryTask'], + ['description' => 'Response parameters changed', 'api' => 'GetUserDeliveryTask'], + ['description' => 'Request parameters changed', 'api' => 'UpdateUserDeliveryTask'], + ], + 'createdAt' => '2024-12-26T08:22:34.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.InvalidDSRecordName', - 'message' => 'Please add/import an NS record with the same name before adding this DS record.', - 'http_code' => 400, - 'description' => 'Please add/import an NS record with the same name before adding this DS record', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetOriginProtection'], + ], + 'createdAt' => '2024-12-24T01:43:07.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.InvalidHostPolicy', - 'message' => 'The host parameter in the origin fetch request is invalid.', - 'http_code' => 400, - 'description' => 'The host parameter in the origin fetch request is invalid.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'EditSiteWafSettings'], + ], + 'createdAt' => '2024-12-19T09:11:02.000Z', + 'description' => '', ], [ - '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' => 'The record name you entered does not meet the specifications. Please adjust the record name according to the product documentation.', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetSiteWafSettings'], + ['description' => 'Request parameters changed', 'api' => 'ListWafRules'], + ], + 'createdAt' => '2024-12-12T06:19:10.000Z', + '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' => 'The record name you entered does not meet the specifications. Please adjust the record name according to the product documentation.', + 'apis' => [ + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'PurgeCaches'], + ], + 'createdAt' => '2024-12-06T02:12:12.000Z', + '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' => 'If you add another record, the suffix of the host record must be the same as the site name. Please adjust and try again.', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CommitRoutineStagingCode'], + ['description' => 'Request parameters changed', 'api' => 'CreateRoutine'], + ['description' => 'Request parameters changed', 'api' => 'CreateRoutineRelatedRecord'], + ['description' => 'Request parameters changed', 'api' => 'CreateRoutineRelatedRoute'], + ['description' => 'Request parameters changed', 'api' => 'DeleteRoutine'], + ['description' => 'Request parameters changed', 'api' => 'DeleteRoutineCodeVersion'], + ['description' => 'Request parameters changed', 'api' => 'DeleteRoutineRelatedRecord'], + ['description' => 'Request parameters changed', 'api' => 'DeleteRoutineRelatedRoute'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetRoutine'], + ['description' => 'Request parameters changed', 'api' => 'GetRoutineStagingCodeUploadInfo'], + ], + 'createdAt' => '2024-12-04T05:50:49.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.InvalidSiteEnvironmentName', - 'message' => 'The specified site environment name is invalid.', - 'http_code' => 400, - 'description' => 'The specified site environment name is invalid.', + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateSiteFunction'], + ['description' => 'Response parameters changed', 'api' => 'ListSiteFunctions'], + ['description' => 'Request parameters changed', 'api' => 'UpdateSiteFunction'], + ], + 'createdAt' => '2024-12-04T02:33:41.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.InvalidVanityNSName', - 'message' => 'A vanity nameserver must be an absolute domain name. Correct it and try again.', - 'http_code' => 400, - 'description' => 'You need to enter the full domain name to customize the NS name. Please adjust and submit it again.', + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListSites'], + ['description' => 'Request parameters changed', 'api' => 'ListUserRatePlanInstances'], + ], + 'createdAt' => '2024-11-28T06:42:15.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.InvalidVanityNSNum', - 'message' => 'Enter 2 to 5 vanity nameservers. Correct them and try again.', - 'http_code' => 400, - 'description' => 'Custom NS requires 2~5 names, please adjust and resubmit.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'GetKv'], + ], + 'createdAt' => '2024-11-26T03:44:10.000Z', + 'description' => '', ], [ - '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' => 'Invalid load balancer name. Make sure that you specify a valid subdomain name under your website domain for the load balancer.', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDDoSAllEventList'], + ['description' => 'Error codes changed', 'api' => 'DescribeHttpDDoSAttackIntelligentProtection'], + ['description' => 'Error codes changed', 'api' => 'DescribeHttpDDoSAttackProtection'], + ['description' => 'Error codes changed', 'api' => 'SetHttpDDoSAttackIntelligentProtection'], + ['description' => 'Error codes changed', 'api' => 'SetHttpDDoSAttackProtection'], + ], + 'createdAt' => '2024-11-19T03:36:10.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.MethodFilter', - 'message' => 'The parameter methodFilter is invalid.', - 'http_code' => 400, - 'description' => 'The parameter methodFilter is invalid.', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListRecords'], + ], + 'createdAt' => '2024-11-19T01:42:35.000Z', + 'description' => '', ], [ - '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' => 'The Name parameter is not valid. Check the Name parameter, which is between 6 and 128 characters. After modification, call the interface again.', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListWafManagedRules'], + ['description' => 'Request parameters changed', 'api' => 'ListWafTemplateRules'], + ], + 'createdAt' => '2024-11-12T07:31:28.000Z', + 'description' => '', ], [ - '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' => 'The incoming domain name or some domain names cannot be found based on the user and product type.', + 'apis' => [ + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'BatchCreateRecords'], + ['description' => 'Response parameters changed', 'api' => 'ListUserRatePlanInstances'], + ], + 'createdAt' => '2024-11-12T05:58:05.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.NotMatchedCoverage', - 'message' => 'The domain name and the coverage of the site are inconsistent.', - 'http_code' => 400, - 'description' => 'The domain name and the acceleration area of the site are inconsistent.', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateScheduledPreloadExecutions'], + ], + 'createdAt' => '2024-11-12T03:12:55.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.NotMatchedRootDomain', - 'message' => 'The domain name does not match the root domain name information for the site.', - 'http_code' => 400, - 'description' => 'The domain name does not match the root domain name information for the site.', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetEdgeContainerAppVersion'], + ['description' => 'Response parameters changed', 'api' => 'ListEdgeContainerAppVersions'], + ], + 'createdAt' => '2024-11-12T02:07:43.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.NotSupportedDomainBiz', - 'message' => 'The business type of the domain name is not supported.', - 'http_code' => 400, - 'description' => 'The business type of the domain name is not supported.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CommitRoutineStagingCode'], + ['description' => 'Error codes changed', 'api' => 'CreateRoutine'], + ['description' => 'Error codes changed', 'api' => 'CreateRoutineRelatedRecord'], + ['description' => 'Error codes changed', 'api' => 'CreateRoutineRelatedRoute'], + ['description' => 'Error codes changed', 'api' => 'DeleteRoutine'], + ['description' => 'Error codes changed', 'api' => 'DeleteRoutineCodeVersion'], + ['description' => 'Error codes changed', 'api' => 'DeleteRoutineRelatedRecord'], + ['description' => 'Error codes changed', 'api' => 'DeleteRoutineRelatedRoute'], + ], + 'createdAt' => '2024-11-05T06:55:41.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.NotSupportedDomainStatus', - 'message' => 'The status of the domain name is not allowed.', - 'http_code' => 400, - 'description' => 'The status of the domain name is not allowed.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateRecord'], + ['description' => 'Error codes changed', 'api' => 'UpdateSiteAccessType'], + ['description' => 'Error codes changed', 'api' => 'UpdateSiteVanityNS'], + ], + 'createdAt' => '2024-11-05T03:28:14.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.NotSupportedMultiChannelDomain', - 'message' => 'The multi-channel domain are not supported.', - 'http_code' => 400, - 'description' => 'Multi-channel domain names are not supported.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CheckUserProjectName'], + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'CreateSiteDeliveryTask'], + ['description' => 'Error codes changed', 'api' => 'CreateUserDeliveryTask'], + ['description' => 'Error codes changed', 'api' => 'DeleteSiteDeliveryTask'], + ['description' => 'Error codes changed', 'api' => 'DeleteUserDeliveryTask'], + ['description' => 'Error codes changed', 'api' => 'GetUserDeliveryTask'], + ['description' => 'Error codes changed', 'api' => 'ListUserDeliveryTasks'], + ['description' => 'Error codes changed', 'api' => 'UpdateSiteDeliveryTask'], + ['description' => 'Error codes changed', 'api' => 'UpdateUserDeliveryTask'], + ['description' => 'Error codes changed', 'api' => 'UpdateUserDeliveryTaskStatus'], + ], + 'createdAt' => '2024-10-18T01:07:45.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.NotSupportVendor', - 'message' => 'Do not support the vendor, please select the vendor supported.', - 'http_code' => 400, - 'description' => 'Do not support the vendor, please select the vendor supported.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ListInstanceQuotas'], + ['description' => 'Error codes changed', 'api' => 'ListInstanceQuotasWithUsage'], + ], + 'createdAt' => '2024-10-15T09:24:31.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.ObjectId', - 'message' => 'Invalid task ID or execution plan ID.', - 'http_code' => 400, - 'description' => 'Invalid task ID or execution plan ID.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'UpdateSiteCoverage'], + ], + 'createdAt' => '2024-10-15T05:53:31.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.ObjectsAndSiteIds', - 'message' => 'The specified Objects and SiteIds variables cannot both be empty strings.', - 'http_code' => 400, - 'description' => 'The specified Objects and SiteIds variables cannot both be empty strings.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ListEdgeContainerApps'], + ], + 'createdAt' => '2024-10-15T03:49:31.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.OrderKey', - 'message' => 'The specified OrderKey is invalid. Please check the OrderKey parameter.', - 'http_code' => 400, - 'description' => 'The OrderKey parameter is invalid. Please check the OrderKey parameter, as it cannot be assigned illegal characters such as @, #, % etc. Please make the necessary modifications and call the interface again.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'SetCertificate'], + ], + 'createdAt' => '2024-10-15T03:45:45.000Z', + 'description' => '', ], [ - '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' => 'The OrderType parameter is invalid. Please check the OrderType parameter. You may not have set it to Asc or Desc. Please modify it and call the interface again.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'PreloadCaches'], + ['description' => 'Error codes changed', 'api' => 'PurgeCaches'], + ], + 'createdAt' => '2024-10-15T01:59:01.000Z', + 'description' => '', ], [ - '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' => 'Failed to verify parameter PageNumber.Check whether the parameter exists and is set to a positive integer.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'BatchCreateRecords'], + ], + 'createdAt' => '2024-10-11T06:14:16.000Z', + 'description' => '', ], [ - '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' => 'The Percentage parameter is invalid. Check the Percentage parameter. The parameter range is 1-100. Modify the parameter and call the interface again.', + 'apis' => [ + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'CreateRecord'], + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'UpdateRecord'], + ], + 'createdAt' => '2024-10-10T12:01:55.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.Port', - 'message' => 'Invalid edge port or origin port. Enter a valid port as required in the interface document.', - 'http_code' => 400, - 'description' => 'Invalid edge port or origin port. Enter a valid port as required in the interface document.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ListInstanceQuotasWithUsage'], + ], + 'createdAt' => '2024-10-10T07:17:08.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.Protocol', - 'message' => 'Invalid port protocol. Enter a valid port protocol as required by the interface documentation.', - 'http_code' => 400, - 'description' => 'Invalid port protocol. Enter a valid port protocol as required by the interface documentation.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateSite'], + ], + 'createdAt' => '2024-10-10T02:02:02.000Z', + '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' => 'The PublishEnv parameter is invalid. Please check the PublishEnv parameter. You may not have set it to prod or staging one of them. Please modify it and call the interface again.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateSite'], + ], + 'createdAt' => '2024-10-08T03:27:01.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.RecordCommentExceedLimit', - 'message' => 'The number of incoming record comment exceeds the maximum limit.', - 'http_code' => 400, - 'description' => 'The record comment information is greater than 50 characters.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'SetCertificate'], + ], + 'createdAt' => '2024-10-03T13:49:15.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.RecordData', - 'message' => 'Invalid record content. Adjust your configurations based on the API documentation.', - 'http_code' => 400, - 'description' => 'Invalid record content. Adjust your configurations based on the API documentation.', + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListManagedRulesGroups'], + ], + 'createdAt' => '2024-09-29T05:47:36.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.RecordNameExceedLimit', - 'message' => 'The length of the record name exceeds the maximum limit.', - 'http_code' => 400, - 'description' => 'The record name cannot exceed 200 characters.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CheckSiteProjectName'], + ['description' => 'Error codes changed', 'api' => 'CheckUserProjectName'], + ['description' => 'Error codes changed', 'api' => 'CreateSiteCustomLog'], + ['description' => 'Error codes changed', 'api' => 'CreateSiteDeliveryTask'], + ['description' => 'Error codes changed', 'api' => 'CreateUserDeliveryTask'], + ['description' => 'Error codes changed', 'api' => 'DeleteSiteDeliveryTask'], + ['description' => 'Error codes changed', 'api' => 'DeleteUserDeliveryTask'], + ['description' => 'Error codes changed', 'api' => 'GetRealtimeDeliveryField'], + ['description' => 'Error codes changed', 'api' => 'GetSiteCustomLog'], + ['description' => 'Error codes changed', 'api' => 'GetSiteDeliveryTask'], + ], + 'createdAt' => '2024-09-27T05:57:43.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.RecordNotBelongToSite', - 'message' => 'The record name passed in does not belong to the current site.', - 'http_code' => 400, - 'description' => 'The record name passed in does not belong to the current site.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'BatchCreateWafRules'], + ['description' => 'Error codes changed', 'api' => 'BatchGetExpressionFields'], + ['description' => 'Error codes changed', 'api' => 'BatchUpdateWafRules'], + ['description' => 'Error codes changed', 'api' => 'CreateList'], + ['description' => 'Error codes changed', 'api' => 'CreatePage'], + ['description' => 'Error codes changed', 'api' => 'CreateWafRule'], + ['description' => 'Error codes changed', 'api' => 'DeleteList'], + ['description' => 'Error codes changed', 'api' => 'DeletePage'], + ['description' => 'Error codes changed', 'api' => 'DeleteWafRule'], + ['description' => 'Error codes changed', 'api' => 'DeleteWafRuleset'], + ], + 'createdAt' => '2024-09-25T07:03:22.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.RecordsExceedLimit', - 'message' => 'The number of incoming records exceeds the maximum limit.', - 'http_code' => 400, - 'description' => 'The number of incoming records exceeds the maximum limit.', + 'apis' => [ + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'ListLists'], + ], + 'createdAt' => '2024-09-25T07:02:13.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.RecordType', - 'message' => 'Invalid record type. Adjust your configurations based on the API documentation.', - 'http_code' => 400, - 'description' => 'Invalid record type. Adjust your configurations based on the API documentation.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'UpdateSiteCoverage'], + ], + 'createdAt' => '2024-09-24T09:14:10.000Z', + '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' => 'The origin of the forwarding rule does not exist or is invalid. Enter the correct origin and try again.', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateSiteDeliveryTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateUserDeliveryTask'], + ], + 'createdAt' => '2024-09-24T08:32:17.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.SiteEnvironmentRuleDuplicate', - 'message' => 'The specified site environment rule is the same as an existing environment.', - 'http_code' => 400, - 'description' => 'The specified site environment rule is the same as an existing environment.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'BatchCreateRecords'], + ['description' => 'Error codes changed', 'api' => 'CreateRecord'], + ['description' => 'Error codes changed', 'api' => 'UpdateRecord'], + ], + 'createdAt' => '2024-09-24T08:28:53.000Z', + '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' => 'Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'BlockObject'], + ], + 'createdAt' => '2024-09-24T06:04:45.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.SiteId', - 'message' => 'The specified SiteId is invalid.', - 'http_code' => 400, - 'description' => 'The specified SiteId is invalid.Check parameter SiteId and try again.', + 'apis' => [ + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'CreateRecord'], + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'GetRecord'], + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'ListRecords'], + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'UpdateRecord'], + ], + 'createdAt' => '2024-09-23T08:54:00.000Z', + 'description' => '', ], [ - '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' => 'Invalid website name. Specify a valid name that contains letters and digits and does not contain special characters.', + 'apis' => [ + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'ListSites'], + ], + 'createdAt' => '2024-09-23T07:17:24.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.SiteVersionDescExceedLimit', - 'message' => 'The specified site version description exceeds the maximum length.', - 'http_code' => 400, - 'description' => 'The specified site version description exceeds the maximum length.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'BatchUpdateWafRules'], + ], + 'createdAt' => '2024-09-23T06:20:25.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.StateFilter', - 'message' => 'The parameter stateFilter is invalid.', - 'http_code' => 400, - 'description' => 'The parameter stateFilter is invalid.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ActivateClientCertificate'], + ], + 'createdAt' => '2024-09-23T02:16:50.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.TagValue', - 'message' => 'The specified TagValue is invalid.', - 'http_code' => 400, - 'description' => 'The TagValue parameter is invalid.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'BatchDeleteKv'], + ['description' => 'Error codes changed', 'api' => 'BatchDeleteKvWithHighCapacity'], + ['description' => 'Error codes changed', 'api' => 'BatchPutKv'], + ['description' => 'Error codes changed', 'api' => 'BatchPutKvWithHighCapacity'], + ['description' => 'Error codes changed', 'api' => 'GetKvNamespace'], + ['description' => 'Error codes changed', 'api' => 'ListKvs'], + ['description' => 'Error codes changed', 'api' => 'PutKv'], + ['description' => 'Error codes changed', 'api' => 'PutKvAccount'], + ['description' => 'Error codes changed', 'api' => 'PutKvWithHighCapacity'], + ['description' => 'Error codes changed', 'api' => 'UpdateKvNamespace'], + ], + 'createdAt' => '2024-09-20T13:50:13.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.TimeRange', - 'message' => 'The specified time range exceeds the limit. Adjust it and try again.', - 'http_code' => 400, - 'description' => 'The specified time range exceeds the limit. Adjust it and try again.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateList'], + ['description' => 'Error codes changed', 'api' => 'CreateManagedRulesGroup'], + ['description' => 'Error codes changed', 'api' => 'CreatePage'], + ['description' => 'Error codes changed', 'api' => 'SetCertificate'], + ['description' => 'Error codes changed', 'api' => 'UpdateList'], + ], + 'createdAt' => '2024-09-18T09:54:23.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.Type', - 'message' => 'The specified Type parameter is invalid, please check and try again.', - 'http_code' => 400, - 'description' => 'The Type parameter you configured is incorrect. Please check and try again. Certificate application type support lets_encrypt, digicert_single, digicert_wildcard.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CheckSiteName'], + ['description' => 'Error codes changed', 'api' => 'EditSiteWafSettings'], + ['description' => 'Error codes changed', 'api' => 'ExportRecords'], + ['description' => 'Error codes changed', 'api' => 'GetList'], + ['description' => 'Error codes changed', 'api' => 'GetManagedRulesGroup'], + ['description' => 'Error codes changed', 'api' => 'GetSite'], + ['description' => 'Error codes changed', 'api' => 'GetSiteCurrentNS'], + ['description' => 'Error codes changed', 'api' => 'GetSiteWafSettings'], + ], + 'createdAt' => '2024-09-18T08:57:12.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.UnSatisfiedDomainSources', - 'message' => 'The basic origin sources of the domain is not satisfied.', - 'http_code' => 400, - 'description' => 'The basic origin information of the domain name is not satisfied.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'GetWafBotAppKey'], + ['description' => 'Error codes changed', 'api' => 'GetWafFilter'], + ['description' => 'Error codes changed', 'api' => 'GetWafQuota'], + ['description' => 'Error codes changed', 'api' => 'GetWafRuleset'], + ['description' => 'Error codes changed', 'api' => 'ListEdgeContainerAppRecords'], + ['description' => 'Error codes changed', 'api' => 'ListEdgeContainerRecords'], + ['description' => 'Error codes changed', 'api' => 'ListEdgeRoutineRecords'], + ['description' => 'Error codes changed', 'api' => 'ListLists'], + ['description' => 'Error codes changed', 'api' => 'ListManagedRulesGroups'], + ['description' => 'Error codes changed', 'api' => 'ListPages'], + ], + 'createdAt' => '2024-09-18T08:07:13.000Z', + 'description' => '', ], [ - 'code' => 'InvalidParameter.VanityNSNameDuplicate', - 'message' => 'The vanity nameservers are duplicated. Please delete it and try again.', - 'http_code' => 400, - 'description' => 'Duplicate custom NS name exists, please delete and resubmit.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'BatchCreateRecords'], + ['description' => 'Error codes changed', 'api' => 'BatchCreateWafRules'], + ['description' => 'Error codes changed', 'api' => 'BatchGetExpressionFields'], + ['description' => 'Error codes changed', 'api' => 'BatchUpdateWafRules'], + ['description' => 'Error codes changed', 'api' => 'ListTagResources'], + ['description' => 'Error codes changed', 'api' => 'ListWafPhases'], + ['description' => 'Error codes changed', 'api' => 'ListWafRulesets'], + ['description' => 'Error codes changed', 'api' => 'ListWafTemplateRules'], + ['description' => 'Error codes changed', 'api' => 'ListWafUsageOfRules'], + ['description' => 'Error codes changed', 'api' => 'ListWaitingRoomEvents'], + ], + 'createdAt' => '2024-09-18T06:14:20.000Z', + 'description' => '', ], [ - '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' => 'The VersionId parameter 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.', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'SetCertificate'], + ], + 'createdAt' => '2024-09-06T06:59:23.000Z', + 'description' => '', ], - [ - 'code' => 'InvalidParameters', - 'message' => 'The specified parameters are invalid.', - 'http_code' => 400, - 'description' => 'Parameter is illegal.', - ], - [ - 'code' => 'InvalidParameters.InvalidUrls', - 'message' => 'The specified urls are invalid.', - 'http_code' => 400, - 'description' => 'The requested URL parameter is invalid.', - ], - [ - 'code' => 'InvalidParameter_ApiItems_Api', - 'message' => 'The parameter apiItems api is invalid.', - 'http_code' => 400, - 'description' => 'The parameter apiItems api is invalid.', - ], - [ - 'code' => 'InvalidParameter_ApiItems_Host', - 'message' => 'The parameter apiItems host is invalid.', - 'http_code' => 400, - 'description' => 'The parameter apiItems host is invalid.', - ], - [ - 'code' => 'InvalidParameter_ApiShieldQuota', - 'message' => 'This website does not have the permission to view API security features.', - 'http_code' => 400, - 'description' => 'This website does not have the permission to view API security features.', - ], - [ - 'code' => 'InvalidParameter_EndpointId', - 'message' => 'The EndpointId is invalid.', - 'http_code' => 400, - 'description' => 'The EndpointId is invalid.', - ], - [ - 'code' => 'InvalidParameter_FuzzySearch', - 'message' => 'The parameter fuzzySearch is invalid.', - 'http_code' => 400, - 'description' => 'The parameter fuzzySearch is invalid.', - ], - [ - 'code' => 'InvalidParameter_MethodFilter', - 'message' => 'The parameter methodFilter is invalid.', - 'http_code' => 400, - 'description' => 'The parameter methodFilter is invalid.', - ], - [ - 'code' => 'InvalidParameter_StateFilter', - 'message' => 'The parameter stateFilter is invalid.', - 'http_code' => 400, - 'description' => 'The parameter stateFilter is invalid.', - ], - [ - 'code' => 'InvalidRegionId.Malformed', - 'message' => 'The specified RegionId is invalid.', - 'http_code' => 400, - 'description' => 'The RegionId parameter is set to an invalid value.', - ], - [ - 'code' => 'InvalidResourceId.NotFound', - 'message' => 'The specified resource does not exist or is released.', - 'http_code' => 404, - 'description' => 'The resource does not exist or has been released.', - ], - [ - 'code' => 'InvalidRoutine', - 'message' => 'The name of routine is invalid.', - 'http_code' => 400, - 'description' => 'Edge function name is illegal.', - ], - [ - '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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.', - ], - [ - 'code' => 'InvalidSiteName', - 'message' => 'Invalid website name. Check and try again.', - 'http_code' => 400, - 'description' => 'Invalid website name. Check and try again.', - ], - [ - 'code' => 'InvalidSSLPri', - 'message' => 'The specified PrivateKey is invalid.', - 'http_code' => 400, - 'description' => 'The value specified for the PrivateKey parameter is invalid.', - ], - [ - 'code' => 'InvalidSSLPub', - 'message' => 'The specified Certificate is invalid.', - 'http_code' => 400, - 'description' => 'The value specified for the Certificate parameter is invalid.', - ], - [ - 'code' => 'InvalidStartTime.Malformed', - 'message' => 'The specified StartTime parameter is invalid.', - 'http_code' => 400, - 'description' => 'Please provide the correct start time format. The date format follows ISO8601 notation and uses UTC time in the format yyyy-MM-ddTHH:mm:ssZ.', - ], - [ - 'code' => 'InvalidStartTime.ValueNotSupported', - 'message' => 'The StartTime cannot exceed 31 days before the current time.', - 'http_code' => 400, - 'description' => 'The request parameter StartTime cannot be 31 days less than the current time.', - ], - [ - 'code' => 'InvalidStationParameter', - 'message' => 'The specified Station is invalid.', - 'http_code' => 400, - 'description' => 'The specified node parameter is invalid.', - ], - [ - 'code' => 'InvalidTaskId.Malformed', - 'message' => 'The specified taskId is invalid.', - 'http_code' => 400, - 'description' => 'The specified task ID is invalid.', - ], - [ - 'code' => 'InvalidTime', - 'message' => 'The query time cannot exceed the last 3 days.', - 'http_code' => 400, - 'description' => 'The query time cannot exceed the last 3 days.', - ], - [ - 'code' => 'InvalidTime.Malformed', - 'message' => 'Specified start time or end time is malformed.', - 'http_code' => 400, - 'description' => 'The specified time format is incorrect. The time must conform to the yyyy-MM-ddTHH:mm:ssZ format. Please enter it correctly and try again.', - ], - [ - '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' => '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.', - ], - [ - 'code' => 'InvalidValOfDelHeader', - 'message' => 'The delete header operation does not support setting value.', - 'http_code' => 400, - 'description' => 'The delete header operation does not support setting value.', - ], - [ - 'code' => 'InvalidValue.ExceedsMaximum', - 'message' => 'The size of the value cannot exceed 2,000,000 bytes.', - 'http_code' => 400, - 'description' => 'The value deposited is too large.', - ], - [ - 'code' => 'InvalidVersion.NotFound', - 'message' => 'The version does not exist.', - 'http_code' => 400, - 'description' => 'This version number does not exist.'."\n", - ], - [ - 'code' => 'IpaNotActive', - 'message' => 'The ipa application is not active.', - 'http_code' => 400, - 'description' => 'The ipa application is not active.', - ], - [ - 'code' => 'IpaResourceUnavailable', - 'message' => 'The resource is unavailable.', - 'http_code' => 400, - 'description' => 'The resource is unavailable.', - ], - [ - 'code' => 'List.BeingBound', - 'message' => 'The specified list is being bound.', - 'http_code' => 403, - 'description' => 'The specified list is being bound by one or more protection rules.', - ], - [ - 'code' => 'List.Name.AlreadyExist', - 'message' => 'The specified list name already exists.', - 'http_code' => 403, - 'description' => 'The specified list name is already used by another list.', - ], - [ - 'code' => 'List.NotExist', - 'message' => 'The specified list does not exist.', - 'http_code' => 403, - 'description' => 'The specified list does not exist.', - ], - [ - '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' => '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.', - ], - [ - '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' => 'Your current plan does not allow you to configure the load balancer\'s health detection. Upgrade the plan and try again.', - ], - [ - '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' => 'The load balancer name or the hostname for the origin pool already exists. Try again with a unique name.', - ], - [ - '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' => '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.', - ], - [ - 'code' => 'LoadBalancerNotExist', - 'message' => 'The load balancer does not exist.', - 'http_code' => 400, - 'description' => 'The input load balancer ID does not exist. Please confirm the ID and try again.', - ], - [ - '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' => '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.', - ], - [ - 'code' => 'LoadBalancerPolicyCheckFailed', - 'message' => 'Your current plan does not support the load balancer scheduling policy. Upgrade the plan and try again.', - 'http_code' => 400, - 'description' => 'Your current plan does not support the load balancer scheduling policy. Upgrade the plan and try again.', - ], - [ - 'code' => 'LoadBalancerQuotaCheckFailed', - 'message' => 'Load balancer enable quota check failed.', - 'http_code' => 400, - 'description' => 'Your current plan cannot use the load balancer related functions. If you need to use it, upgrade the plan.', - ], - [ - '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' => '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.', - ], - [ - 'code' => 'LockFailed', - 'message' => 'The system is handling requests you previously submitted. Try again later.', - 'http_code' => 400, - 'description' => 'The system is handling requests you previously submitted. Try again later.', - ], - [ - 'code' => 'LogNotFound', - 'message' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', - 'http_code' => 404, - 'description' => 'Failed to query the log. Check whether the task ID and execution ID are valid.', - ], - [ - 'code' => 'LogserviceNotFound', - 'message' => 'Log Service has not been activated.', - 'http_code' => 403, - 'description' => 'Real-time log delivery is not activated.', - ], - [ - 'code' => 'LogstoreNotExist', - 'message' => 'Logstore does not exist.', - 'http_code' => 404, - 'description' => 'The specified Logstore does not exist.', - ], - [ - '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' => 'Failed to delete the WAF managed rule group because it has been associated with one or more rules. Disassociate the rules and try again.', - ], - [ - 'code' => 'ManagedRulesGroup.Name.Invalid', - 'message' => 'Invalid name for the WAF managed rule group. Try again with a valid name.', - 'http_code' => 403, - 'description' => 'Invalid name for the WAF managed rule group. Try again with a valid name.', - ], - [ - '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' => '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.', - ], - [ - 'code' => 'Match.Malformed', - 'message' => 'The specified parameter match is malformed or does not adhere to the required format.', - 'http_code' => 403, - 'description' => 'The specified Match parameter is malformed or does not adhere to the required format.', - ], - [ - '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' => 'When importing domain name configurations, you need to pass in the specific feature configurations, but they are not received.', - ], - [ - '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' => 'The following conditions are not supported in the Import Domain Name Configuration Tool. Check the following information and execute again:'."\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.', - ], - [ - 'code' => 'MissingConfigId', - 'message' => 'Required parameter ConfigId missing. Specify ConfigId and try again.', - 'http_code' => 400, - 'description' => 'Required parameter ConfigId missing. Specify ConfigId and try again.', - ], - [ - 'code' => 'MissingOssUrl', - 'message' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', - 'http_code' => 400, - 'description' => 'OssUrl missing. Specify a valid URL of the OSS object that stores URLs to prefetch.', - ], - [ - 'code' => 'MissingParameter', - 'message' => 'Required parameter RecordName missing. Specify RecordName and try again.', - 'http_code' => 400, - 'description' => 'Required parameter RecordName missing. Specify RecordName and try again.', - ], - [ - 'code' => 'MissingParameter', - 'message' => 'The specified ArgName is required for this function.', - 'http_code' => 400, - 'description' => 'When configuring a specific function, the required parameter is missing.', - ], - [ - 'code' => 'MissingParameter.ObjectType', - 'message' => 'The ObjectType parameter is required if DomainName or ObjectType is specified.', - 'http_code' => 400, - 'description' => 'Specify the ObjectType parameter.', - ], - [ - 'code' => 'MissingParamsError', - 'message' => 'Missing required params.', - 'http_code' => 400, - 'description' => 'Missing necessary parameters', - ], - [ - 'code' => 'MissingSiteId', - 'message' => 'Required parameter SiteId missing. Specify SiteId and try again.', - 'http_code' => 400, - 'description' => 'Required parameter SiteId missing. Specify SiteId and try again.', - ], - [ - 'code' => 'MissingTimeParameter', - 'message' => 'The StartTime and EndTime must be both specified.', - 'http_code' => 400, - 'description' => 'Please provide both a start time and an end time.', - ], - [ - 'code' => 'MissingUrlList', - 'message' => 'Enter the URLs you want to prefetch.', - 'http_code' => 400, - 'description' => 'Enter the URLs you want to prefetch.', - ], - [ - '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' => 'Invalid response body. Specify a response body that does not exceed 102,400 characters in length in your custom rule.', - ], - [ - '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' => '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.', - ], - [ - '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' => 'The incoming monitor is carrying an illegal request header. Make sure that the number of request headers does not exceed 10, that each request header has a value length between 1 and 10, and that you must not use the User-Agent request header (which is reserved for internal specific scenarios). In addition, the total length of all request headers and their values must not exceed 6000 characters. Please check and correct the request header configuration and try again.', - ], - [ - 'code' => 'MonitorMethodNotSupport', - 'message' => 'Invalid HTTP method for the probe request. Valid values are GET and HEAD.', - 'http_code' => 400, - 'description' => 'Invalid HTTP method for the probe request. Valid values are GET and 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' => '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.', - ], - [ - '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' => 'The incoming monitor listening port is not supported. The port value range is [1-65535]. Please ensure that the port is within the value range and try again.', - ], - [ - 'code' => 'MonitorRetriesInvalid', - 'message' => 'Invalid number of probe retries. Specify an integer from 0 to 5. Then, try again.', - 'http_code' => 400, - 'description' => 'Invalid number of probe retries. Specify an integer from 0 to 5. Then try again.', - ], - [ - 'code' => 'MonitorTimeoutInvalid', - 'message' => 'Invalid timeout for the probe. Valid values are 1 to 10.', - 'http_code' => 400, - 'description' => 'Invalid timeout for the probe. Valid values are 1 to 10.', - ], - [ - 'code' => 'MonitorTypeNotSupport', - 'message' => 'Invalid protocol. Valid values are off, HTTP, HTTPS, TCP, UDP, ICMP Ping, and SMTP.', - 'http_code' => 400, - 'description' => 'Invalid protocol. Valid values are off, HTTP, HTTPS, TCP, UDP, ICMP Ping, and SMTP.', - ], - [ - 'code' => 'NameAlreadyExists', - 'message' => 'The name already exists.', - 'http_code' => 400, - 'description' => 'Name already exists.', - ], - [ - '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' => '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).', - ], - [ - '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' => 'The number of embedded sub-conditions in the rule exceeds the plan limit. Please check the plan description and upgrade your plan.', - ], - [ - 'code' => 'NoAvaliablePaymentMethod', - 'message' => 'No payment method is specified for your account. We recommend that you add a payment method.', - 'http_code' => 400, - 'description' => 'No payment method has been specified for your account. We recommend that you add a payment method.', - ], - [ - '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' => '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.', - ], - [ - 'code' => 'NoPermission', - 'message' => 'Permission denied.', - 'http_code' => 400, - 'description' => 'No permission', - ], - [ - 'code' => 'NoRealNameAuthentication', - 'message' => 'You have not completed real-name authentication.', - 'http_code' => 400, - 'description' => 'You have not completed real-name authentication.', - ], - [ - 'code' => 'NotExist.MigratedTask', - 'message' => 'The specified task does not exist.', - 'http_code' => 400, - 'description' => 'The specified task does not exist.', - ], - [ - 'code' => 'OperationDenied.DefaultSiteEnvironmentUneditable', - 'message' => 'The rule of the default environment is not allowed to be modified.', - 'http_code' => 400, - 'description' => 'The rule of the default environment is not allowed to be modified.', - ], - [ - 'code' => 'OperationDenied.UnsupportPlan', - 'message' => 'The current plan does not support this operation. Use the correct plan instance to try again.', - 'http_code' => 400, - 'description' => 'The current plan does not support this operation. Use the correct plan instance to try again.', - ], - [ - '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' => 'Sites that are accessed only by NS mode can use custom NS. Please adjust your site access mode and try again.', - ], - [ - 'code' => 'Order.InstanceHasUnpaidOrder', - 'message' => 'You have an unpaid order. Complete the payment or cancel the order first.', - 'http_code' => 400, - 'description' => 'You have an unpaid order. Complete the payment or cancel the order first.', - ], - [ - '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' => 'The specified origin pool name already exists or its hostname conflicts with a load balancer name. Try again with a unique name.', - ], - [ - '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' => 'The specified origin pool does not exist or does not belong to your account or website. Check and try again.', - ], - [ - 'code' => 'OriginProtectionNotExist', - 'message' => 'The site is not configured with origin protection, so it cannot be modified or deleted.', - 'http_code' => 400, - 'description' => 'The site is not configured with origin protection, so it cannot be modified or deleted.', - ], - [ - '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' => '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.', - ], - [ - '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' => 'The specified custom error page has been associated with one or more protection rules. Dissociate the protection rules and try again.', - ], - [ - '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' => '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.', - ], - [ - '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' => '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.', - ], - [ - 'code' => 'ParameterAlreadyExist', - 'message' => 'Parameter uniqueness verification failed. Check for duplicate parameter values.', - 'http_code' => 400, - 'description' => 'Parameter uniqueness verification failed. Check for duplicate parameter values.', - ], - [ - 'code' => 'ParameterNotExist', - 'message' => 'The specified parameter does not exist. Check your configurations and try again.', - 'http_code' => 400, - 'description' => 'The specified parameter does not exist. Check your configurations and try again.', - ], - [ - 'code' => 'ParamNameError', - 'message' => 'The Name parameter is invalid.', - 'http_code' => 400, - 'description' => 'The Name parameter is illegal.'."\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' => '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.', - ], - [ - 'code' => 'PolicyNameExist', - 'message' => 'The policy name already exists.', - 'http_code' => 400, - 'description' => 'Policy name already exists.', - ], - [ - 'code' => 'PolicyNotExist', - 'message' => 'The policy does not exist.', - 'http_code' => 400, - 'description' => 'The policy does not exist. ', - ], - [ - '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' => '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.', - ], - [ - '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' => 'Failed to delete the origin pool because it has been referenced.Remove all references to the pool and try again.', - ], - [ - 'code' => 'PreloadQueueFull', - 'message' => 'The prefetch queue is full. Try again later.', - 'http_code' => 400, - 'description' => 'The prefetch queue is full, and you need to retry after the queue is processed.', - ], - [ - 'code' => 'PrivateKey.MissingParameter', - 'message' => 'The PrivateKey parameter is required.', - 'http_code' => 400, - 'description' => 'Missing PrivateKey parameter.', - ], - [ - 'code' => 'ProjectExist', - 'message' => 'The SLS project has been associated with another account. Check the project name.', - 'http_code' => 200, - 'description' => 'The SLS project has been associated with another account. Check the project name.', - ], - [ - 'code' => 'ProjectNotExist', - 'message' => 'The project does not exist.', - 'http_code' => 404, - 'description' => 'Information about the project is not found.', - ], - [ - 'code' => 'QueryDBError', - 'message' => 'An internal exception occurred when query data, please try again later.', - 'http_code' => 500, - 'description' => 'An internal exception occurred when query data, please try again later.', - ], - [ - 'code' => 'QueryLog.Timeout', - 'message' => 'The query for standard logs timed out. Try again later.', - 'http_code' => 500, - 'description' => 'The query for standard logs timed out. Try again later.', - ], - [ - 'code' => 'QuotaCheckFailed', - 'message' => 'Failed to check free certificate Quota, please try again later.', - 'http_code' => 400, - 'description' => 'Failed to check free certificate Quota, please try again later.', - ], - [ - 'code' => 'QuotaCheckFailed.CustomNS', - 'message' => 'Custom nameservers are not allowed in your plan. Check the plan description and upgrade the plan.', - 'http_code' => 400, - 'description' => 'Custom nameservers are not allowed in your plan. Check the plan description and upgrade the plan.', - ], - [ - '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' => 'The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.', - ], - [ - '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' => 'The specified feature parameter is not allowed in your plan, or the feature parameter configurations have reached the upper limit in your plan.', - ], - [ - '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' => 'Rules engine with regular expressions is not allowed in your plan. Check the plan description and upgrade the plan.', - ], - [ - 'code' => 'QuotaCheckFailed.VersionManagement', - 'message' => 'Insufficient quota for version management. Contact technical support.', - 'http_code' => 400, - 'description' => 'Insufficient quota for version management. Contact technical support.', - ], - [ - 'code' => 'QuotaCheckFailed.VersionManagement', - 'message' => 'The current plan\'s quota of version management is insufficient. Please try to upgrade the plan.', - 'http_code' => 400, - 'description' => 'The version management quota of the current package is insufficient. Please try to upgrade the package version.', - ], - [ - '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' => 'The maximum number of conditions in the rule has been reached. Check the plan description and upgrade the plan.', - ], - [ - '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' => 'The maximum number of records has been reached. Delete some and try again or upgrade your plan.', - ], - [ - 'code' => 'QuotaExceed.SiteCount', - 'message' => 'The maximum number of websites associated with your plan has been reached.', - 'http_code' => 400, - 'description' => 'The maximum number of websites associated with your plan has been reached.', - ], - [ - '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' => 'The maximum number of custom certificates has been reached. Delete some and try again or upgrade your plan.', - ], - [ - 'code' => 'QuotaExceed.WildCardRecord', - 'message' => 'The maximum number of wildcard records has been reached. Delete some and try again.', - 'http_code' => 400, - 'description' => 'The maximum number of wildcard records has been reached. Delete some and try again.', - ], - [ - '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' => 'The number of wildcard records exceeds the plan quota. Contact the sales team to increase your quota.', - ], - [ - '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' => '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.', - ], - [ - 'code' => 'QuotaExceeded', - 'message' => 'The quota is exceeded.', - 'http_code' => 403, - 'description' => 'The quota is exceeded.', - ], - [ - 'code' => 'QuotaExceeded', - 'message' => 'You attempts have exceeded the daily limit.', - 'http_code' => 400, - 'description' => 'Exceeding the same day quota limit. The number of submissions today has been exhausted. You can query the number of times a quota can be used today through the quota API.', - ], - [ - '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' => 'The quota item does not exist or the purchased plan has not taken effect. Confirm and try again.', - ], - [ - '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' => 'Invalid OSS bucket region. Check the region and try again.', - ], - [ - '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' => 'The number of Kafka Broker addresses for real-time log delivery has reached the upper limit (50).', - ], - [ - 'code' => 'RealTimeLog.KafkaConfigError', - 'message' => 'Invalid Kafka information for the delivery task. Check your configurations and try again.', - 'http_code' => 403, - 'description' => 'Invalid Kafka information for the delivery task. Check your configurations and try again.', - ], - [ - 'code' => 'RealTimeLog.LogstoreExist', - 'message' => 'The SLS logstore has been created within this project. Check the project name.', - 'http_code' => 403, - 'description' => 'A Logstore with the same name already exists in the SLS Project. Check the Logstore name.', - ], - [ - 'code' => 'RealTimeLog.NameCheckFail', - 'message' => 'Real-time log name field validity check failed.', - 'http_code' => 403, - 'description' => 'The real-time log configuration field you entered contains illegal characters. Please delete the illegal characters and try again. The allowed characters include numbers, letters, underscore "_" and spaces "".', - ], - [ - 'code' => 'RealTimeLog.OssBucketQueryError', - 'message' => 'Failed to query the OSS bucket. Check the bucket name and try again.', - 'http_code' => 403, - 'description' => 'Failed to query the OSS bucket. Check the bucket name and try again.', - ], - [ - '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' => '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.', - ], - [ - 'code' => 'RealTimeLog.ProjectExistError', - 'message' => 'The real-time log delivery task name already exists. Check the task name and try again.', - 'http_code' => 400, - 'description' => 'The real-time log delivery task name already exists. Check the task name and try again.', - ], - [ - 'code' => 'RealTimeLog.RegexpCheckFail', - 'message' => 'Invalid characters exist in your parameter configurations. Check your configurations and try again.', - 'http_code' => 403, - 'description' => 'Invalid characters exist in your parameter configurations. Check your configurations and try again.', - ], - [ - 'code' => 'RealTimeLog.S3EndpointInvalidError', - 'message' => 'Invalid S3 information for the delivery task. Check your configurations and try again.', - 'http_code' => 403, - 'description' => 'Invalid S3 information for the delivery task. Check your configurations and try again.', - ], - [ - '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' => 'You do not have permissions to create a service-linked role. 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.', - ], - [ - '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' => 'Invalid SLS information. Check whether ProjectName and LogStoreName are correctly configured and whether SLS is activated. Then, try again.', - ], - [ - 'code' => 'RealTimeLog.SlsEndpointError', - 'message' => 'Invalid SLS parameters for the delivery task. Check your configurations and try again.', - 'http_code' => 403, - 'description' => 'Invalid SLS parameters for the delivery task. Check your configurations and try again.', - ], - [ - 'code' => 'RealTimeLog.SlsLogstoreQueryError', - 'message' => 'Failed to query the Logstore. Check the Logstore name and try again.', - 'http_code' => 403, - 'description' => 'Failed to query the Logstore. Check the Logstore name and try again.', - ], - [ - 'code' => 'RealTimeLog.SlsNotOpen', - 'message' => 'You have not activated Alibaba Cloud SLS. Activate SLS first.', - 'http_code' => 403, - 'description' => 'You have not activated Alibaba Cloud SLS. Activate SLS first.', - ], - [ - 'code' => 'RealTimeLog.SlsProjectExistError', - 'message' => 'The SLS project already exists. Check the project name and try again.', - 'http_code' => 403, - 'description' => 'The SLS project already exists. Check the project name and try again.', - ], - [ - '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' => '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.', - ], - [ - 'code' => 'RealtimeLogProjectExistError', - 'message' => 'Realtime-log project name already exist.', - 'http_code' => 400, - 'description' => 'Real-time log entry name already exists', - ], - [ - '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' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', - ], - [ - 'code' => 'Record.AorAAAARecordValueContainInvalidIP', - 'message' => 'The A/AAAA record value contains the invalid IP.', - 'http_code' => 400, - 'description' => 'When creating or editing an A/AAAA record, the record value contains an invalid IP.', - ], - [ - 'code' => 'Record.AorAAAARecordValueContainIPInBlacklist', - 'message' => 'The A/AAAA record value contains the blacklist IP.', - 'http_code' => 400, - 'description' => 'When you create or edit an A/AAAA record, the record value contains the blacklist IP.', - ], - [ - 'code' => 'Record.AorAAAARecordValueIPExceedLimit', - 'message' => 'The number of IP addresses exceeds the limit for the A/AAAA record.', - 'http_code' => 400, - 'description' => 'When creating or editing A/AAAA records, the number of IP addresses exceeds the limit. A host record only supports 8 IPv4 and 4 IPv6 IP addresses. Please adjust and try again.', - ], - [ - 'code' => 'Record.CAARecordFlagExceedLimit', - 'message' => 'The value of the flag parameter for a CAA record is out of range.', - 'http_code' => 400, - 'description' => 'The value of the flag parameter for a CAA record is out of range while creating or editing DNS record information.', - ], - [ - 'code' => 'Record.CAARecordTagExceedLimit', - 'message' => 'The CAA record tag has illegal characters other than issue, issuewild, and iodef.', - 'http_code' => 400, - 'description' => 'When creating or editing CAA records, illegal characters other than issue, issuewild, and iodef are passed in the tag value.', - ], - [ - 'code' => 'Record.CERTRecordAlgorithmExceedLimit', - 'message' => 'The value of the algorithm parameter for the CERT record is out of range.', - 'http_code' => 400, - 'description' => 'The value of the algorithm parameter for the CERT record is out of range while creating or editing DNS record information.', - ], - [ - 'code' => 'Record.CERTRecordKeyTagExceedLimit', - 'message' => 'The value of the keyTag parameter for a CERT record is out of range.', - 'http_code' => 400, - 'description' => 'The value of the keyTag parameter for a CERT record is out of range when creating or editing DNS record information.', - ], - [ - 'code' => 'Record.CERTRecordTypeExceedLimit', - 'message' => 'The CERT record type is out of range.', - 'http_code' => 400, - 'description' => 'The CERT record type parameter was out of range when creating or editing DNS record information.', - ], - [ - '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' => '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.', - ], - [ - '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' => 'The CNAME record cannot be the origin of the added source address pool. Check and try again.', - ], - [ - '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' => 'The CNAME record cannot be the origin of an added record. Check the record values of other records and try again.', - ], - [ - 'code' => 'Record.CNameRecordValueCannotEqualHostRecord', - 'message' => 'The record value of the CNAME record cannot be exactly the same as the host record.', - 'http_code' => 400, - 'description' => 'The record value of the CNAME record cannot be exactly the same as the host record. Please adjust and try again.', - ], - [ - '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' => 'The record value of a CNAME record cannot be exactly the same as the name of another existing Layer 4 proxy record.', - ], - [ - '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' => 'The record value of a CNAME record cannot be the same as the name of another existing CNAME record.', - ], - [ - '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' => 'The CNAME record value contains the blacklist address. For details, you can submit a work order for consultation.', - ], - [ - 'code' => 'Record.CNameRecordValueExceedLimit', - 'message' => 'The CNAME record value cannot exceed 253 characters, please delete and try again.', - 'http_code' => 400, - 'description' => 'The record value cannot exceed 253 characters, please delete and try again.', - ], - [ - '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' => '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.', - ], - [ - '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' => '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.', - ], - [ - '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' => 'The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.', - ], - [ - 'code' => 'Record.EmptyAorAAAARecordValue', - 'message' => 'The A/AAAA record value is empty, please fill it in correctly and try again.', - 'http_code' => 400, - 'description' => 'The A/AAAA record value is empty, please fill it in correctly and try again.', - ], - [ - 'code' => 'Record.EmptyCAARecordValue', - 'message' => 'The CAA record value is empty.', - 'http_code' => 400, - 'description' => 'When creating or editing a CAA record, the value of the record is empty inside.', - ], - [ - 'code' => 'Record.EmptyCNameRecordValue', - 'message' => 'The CNAME record value is empty.', - 'http_code' => 400, - 'description' => 'When creating or editing a CNAME record, the record value is empty. Please fill it in correctly and try again.', - ], - [ - 'code' => 'Record.EmptyMXRecordValue', - 'message' => 'The MX record value cannot be empty.', - 'http_code' => 400, - 'description' => 'When you create or edit an MX record, the record value cannot be empty.', - ], - [ - 'code' => 'Record.EmptyNSRecordValue', - 'message' => 'The NS record value cannot be empty.', - 'http_code' => 400, - 'description' => 'When you create or edit an NS record, the NS record value cannot be empty.', - ], - [ - 'code' => 'Record.EmptyRecordValue', - 'message' => 'The record value is empty, please fill it in correctly and try again.', - 'http_code' => 400, - 'description' => 'The record value is empty, please fill it in correctly and try again.', - ], - [ - 'code' => 'Record.EmptyTXTRecordValue', - 'message' => 'The TXT record value cannot be empty.', - 'http_code' => 400, - 'description' => 'When creating or editing a TXT record, the record value cannot be empty.', - ], - [ - 'code' => 'Record.InvalidCertEncodeWithCERTRecord', - 'message' => 'The certificate value of the CERT record is not base64-encoded.', - 'http_code' => 400, - 'description' => 'When you create or edit CERT record information, the certificate value of the CERT record is not base64-encoded.', - ], - [ - 'code' => 'Record.InvalidFingerprintWithSSHFPRecord', - 'message' => 'The SSHFP record fingerprint value is not hexadecimal encoded.', - 'http_code' => 400, - 'description' => 'When creating or editing SSHFP record information, the fingerprint value is not hexadecimal encoded.', - ], - [ - 'code' => 'Record.InvalidHTTPURLWithCAARecordTag', - 'message' => 'The CAA record is prefixed with http:// or https://, a valid URL must be followed.', - 'http_code' => 400, - 'description' => 'When creating or editing CAA records, when Tag is iodef and Value is prefixed with http:// or https://, a valid URL must be followed.', - ], - [ - 'code' => 'Record.InvalidIdoefDataWithCAARecordTag', - 'message' => 'The CAA record Tag value does not start with mailto: or http:// or https.', - 'http_code' => 400, - 'description' => 'When creating or editing CAA record information, the Tag value does not start with mailto: http:// https.', - ], - [ - 'code' => 'Record.InvalidIodefDataWithCAARecordTag', - 'message' => 'The CAA record Tag value cannot start with mailto: or http:// or https.', - 'http_code' => 400, - 'description' => 'When creating or editing CAA record information, the Tag value cannot start with mailto: http:// or 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' => 'When creating or editing CAA record information, the tag tag of a CAA record can only be a semicolon or a valid domain name separated by semicolons.', - ], - [ - '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' => 'When creating or editing CAA record information, when Tag is iodef and Value is prefixed with mailto:, it must be followed by a legal email address.', - ], - [ - 'code' => 'Record.InvalidSmimeaEncodeWithSMIMEARecord', - 'message' => 'The certificate value of the SMIMEA record is not base64-encoded.', - 'http_code' => 400, - 'description' => 'When creating or editing SMIMEA record information, the certificate value of the SMIMEA record is not base64-encoded.', - ], - [ - 'code' => 'Record.InvalidTslaEncodeWithTSLARecord', - 'message' => 'The certificate value passed in is not hexadecimal encoded with TSLA record.', - 'http_code' => 400, - 'description' => 'When creating or editing TLSA record information, the certificate value passed in is not hexadecimal encoded.', - ], - [ - 'code' => 'Record.InvalidURLWithURIRecord', - 'message' => 'The URI record value must be a valid URL address.', - 'http_code' => 400, - 'description' => 'When creating or editing URI record information, the record value must be a valid URL address.', - ], - [ - 'code' => 'Record.MXRecordPriorityExceedLimit', - 'message' => 'The MX record priority parameter value is out of range.', - 'http_code' => 400, - 'description' => 'When creating or editing DNS record information, the MX record priority parameter value filled in is out of range.', - ], - [ - 'code' => 'Record.NoRecordNameConflictWithNSRecord', - 'message' => 'No record name can conflict with an NS record name.', - 'http_code' => 400, - 'description' => 'No record name can conflict with an NS record name.', - ], - [ - 'code' => 'Record.NoResource', - 'message' => 'Failed to allocate resources for the record. Please submit a ticket for processing.', - 'http_code' => 400, - 'description' => 'Failed to allocate resources for the record. Please submit a work order for processing.', - ], - [ - 'code' => 'Record.NotFound', - 'message' => 'The record does not exist. Check your configurations and try again.', - 'http_code' => 404, - 'description' => 'The record does not exist. Check your configurations and try again.', - ], - [ - 'code' => 'Record.NotFound', - 'message' => 'The record does not exist. Modify it and try again.', - 'http_code' => 404, - 'description' => 'The record does not exist. Modify it and try again.', - ], - [ - 'code' => 'Record.NSRecordCannotEqualSiteName', - 'message' => 'An NS record with the exact same name as the site name is not allowed.', - 'http_code' => 400, - 'description' => 'Adding an NS record with the exact same name as the site name is not allowed.', - ], - [ - 'code' => 'Record.OSSSourceInvalidAuthType', - 'message' => 'The recorded OSS origin station authentication type is not supported.', - 'http_code' => 400, - 'description' => 'The recorded OSS origin station authentication type is not supported.', - ], - [ - 'code' => 'Record.ParseJSONRecordValueFailed', - 'message' => 'The JSON data format of the record data is incorrect. Please adjust and try again.', - 'http_code' => 400, - 'description' => 'The JSON data format of the record data is incorrect. Please adjust and try again.', - ], - [ - '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' => 'If the source station type of the record is source address pool, the input source address pool does not exist.', - ], - [ - 'code' => 'Record.RecordMatchingTypeExceedLimit', - 'message' => 'The matchingType parameter value filled in is out of range.', - 'http_code' => 400, - 'description' => 'While creating or editing DNS record information, the matchingType parameter value filled in is out of range.', - ], - [ - 'code' => 'Record.RecordNameConflictForSpecifiedRecordType', - 'message' => 'The A/AAAA and CNAME records cannot have the same name.', - 'http_code' => 400, - 'description' => 'The A/AAAA and CNAME records cannot have the same name.', - ], - [ - 'code' => 'Record.RecordNameConflictWithIPAName', - 'message' => 'The record name cannot have the same name as the Layer 4 proxy record.', - 'http_code' => 400, - 'description' => 'When you create or edit DNS record information, the record name cannot have the same name as the Layer 4 proxy record.', - ], - [ - 'code' => 'Record.RecordNameConflictWithLBName', - 'message' => 'The record name cannot be the same as the Server Load Balancer record name.', - 'http_code' => 400, - 'description' => 'When creating or editing DNS record information, the record name cannot be the same as the Server Load Balancer record name.', - ], - [ - 'code' => 'Record.RecordNameConflictWithNSRecord', - 'message' => 'The NS record name cannot be the same as any other type of record name.', - 'http_code' => 400, - 'description' => 'When creating or editing DNS record information, the NS record name cannot be the same as any other type of record name.', - ], - [ - 'code' => 'Record.RecordNameConflictWithPoolName', - 'message' => 'The record name cannot be the same as the source address pool record name.', - 'http_code' => 400, - 'description' => 'When creating or editing DNS record information, the record name cannot be the same as the source address pool record name.', - ], - [ - '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' => 'Record conflict with the same record type, there is a host record with the same name with the same record value.', - ], - [ - 'code' => 'Record.RecordNameConflictWithSameRecordType', - 'message' => 'Record conflicts with an existing host record that has the same name and value.', - 'http_code' => 400, - 'description' => 'Record conflicts with an existing host record that has the same name and value.', - ], - [ - 'code' => 'Record.RecordNameInBlacklist', - 'message' => 'The record name is in blacklist.', - 'http_code' => 400, - 'description' => 'The record name is in the blacklist and cannot be added.', - ], - [ - 'code' => 'Record.RecordPriorityExceedLimit', - 'message' => 'The record priority parameter value filled in is out of range.', - 'http_code' => 400, - 'description' => 'When creating or editing DNS record information, the record priority parameter value filled in is out of range.', - ], - [ - 'code' => 'Record.RecordSelectorExceedLimit', - 'message' => 'The selector parameter value filled in is out of range.', - 'http_code' => 400, - 'description' => 'While creating or editing DNS record information, the selector parameter value filled in is out of range.', - ], - [ - 'code' => 'Record.RecordUsageExceedLimit', - 'message' => 'The usage parameter value filled in is out of range.', - 'http_code' => 400, - 'description' => 'When creating or editing DNS record information, the usage parameter value filled in is out of range.', - ], - [ - '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' => 'The record value contains the blacklist address, and the details can be submitted for work order consultation.', - ], - [ - 'code' => 'Record.RecordWeightExceedLimit', - 'message' => 'The record weight parameter value filled in is out of range.', - 'http_code' => 400, - 'description' => 'When creating or editing DNS record information, the record weight parameter value filled in is out of range.', - ], - [ - 'code' => 'Record.Reserved', - 'message' => 'Another operation on the record is in progress. Try again later.', - 'http_code' => 400, - 'description' => 'Another operation on the record is in progress. Try again later.', - ], - [ - 'code' => 'Record.S3SourceInvalidAuthRegion', - 'message' => 'The recorded S3 origin belongs to a region that is not in the supported range.', - 'http_code' => 400, - 'description' => 'The recorded S3 origin belongs to a region that is not in the supported range.', - ], - [ - 'code' => 'Record.S3SourceInvalidAuthType', - 'message' => 'The recorded S3 origin authentication type is not supported.', - 'http_code' => 400, - 'description' => 'The recorded S3 origin authentication type is not supported.', - ], - [ - 'code' => 'Record.S3SourceInvalidAuthVersion', - 'message' => 'The version of the authentication signature algorithm of the S3 origin is not supported.', - 'http_code' => 400, - 'description' => 'The version of the authentication signature algorithm of the S3 origin is not supported.', - ], - [ - 'code' => 'Record.ServiceBusy', - 'message' => 'The record is being configured. Try again later.', - 'http_code' => 400, - 'description' => 'The record is being configured. Try again later.', - ], - [ - 'code' => 'Record.SMIMEARecordMatchingTypeExceedLimit', - 'message' => 'The matchingType parameter value for a SMIMEA record is out of range.', - 'http_code' => 400, - 'description' => 'The matchingType parameter value for a SMIMEA record is out of range while creating or editing DNS record information.', - ], - [ - 'code' => 'Record.SMIMEARecordSelectorExceedLimit', - 'message' => 'The selector parameter value for a SMIMEA record is out of range.', - 'http_code' => 400, - 'description' => 'The selector parameter value for a SMIMEA record is out of range while creating or editing DNS record information.', - ], - [ - 'code' => 'Record.SMIMEARecordUsageExceedLimit', - 'message' => 'The value of the usage parameter for a SMIMEA record is out of range.', - 'http_code' => 400, - 'description' => 'The value of the usage parameter for a SMIMEA record is out of range while creating or editing DNS record information.', - ], - [ - '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' => 'The character length of the AccessKey parameter value for the record source station is out of range.', - ], - [ - 'code' => 'Record.SourceEmptyAK', - 'message' => 'The AccessKey of the account to which the origin site belongs is empty.', - 'http_code' => 400, - 'description' => 'The AccessKey of the account to which the origin site belongs is empty.', - ], - [ - 'code' => 'Record.SourceEmptyAuthConf', - 'message' => 'The authentication information of the origin station is empty.', - 'http_code' => 400, - 'description' => 'The recorded authentication information of the origin station is empty.', - ], - [ - 'code' => 'Record.SourceEmptySecretKey', - 'message' => 'The SecretKey of the account to which the recorded origin site belongs is empty.', - 'http_code' => 400, - 'description' => 'The SecretKey of the account to which the recorded origin site belongs is empty.', - ], - [ - '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' => 'The character length of the SecretKey parameter value for the record source station is out of range.', - ], - [ - '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 host record name is not valid. The SRV host record name must begin with an underscore (-), followed by a lowercase letter (a-z), number (0-9), hyphen (-), followed by any character, followed by an underscore (-) and a lowercase letter, number, or hyphen.', - ], - [ - 'code' => 'Record.SRVRecordPortExceedLimit', - 'message' => 'The SRV record port is out of range.', - 'http_code' => 400, - 'description' => 'When creating or editing DNS record information, the SRV record port filled in is out of range.', - ], - [ - 'code' => 'Record.SRVRecordPriorityExceedLimit', - 'message' => 'The SRV record priority is out of range.', - 'http_code' => 400, - 'description' => 'The SRV record priority is out of range when creating or editing DNS record information.', - ], - [ - 'code' => 'Record.SRVRecordWeightExceedLimit', - 'message' => 'The SRV record weight is out of range.', - 'http_code' => 400, - 'description' => 'When creating or editing DNS record information, the SRV record weight filled in is out of range.', - ], - [ - 'code' => 'Record.SSHFPRecordAlgorithmExceedLimit', - 'message' => 'The algorithm parameter value for the SSHFP record is out of range.', - 'http_code' => 400, - 'description' => 'The algorithm parameter value for the SSHFP record is out of range while creating or editing DNS record information.', - ], - [ - 'code' => 'Record.TLSARecordMatchingTypeExceedLimit', - 'message' => 'The matchingType parameter value for the TLSA record is out of range.', - 'http_code' => 400, - 'description' => 'The matchingType parameter value for the TLSA record is out of range while creating or editing DNS record information.', - ], - [ - 'code' => 'Record.TLSARecordSelectorExceedLimit', - 'message' => 'The selector parameter value for the TLSA record is out of range.', - 'http_code' => 400, - 'description' => 'The selector parameter value for the TLSA record is out of range while creating or editing DNS record information.', - ], - [ - 'code' => 'Record.TLSARecordUsageExceedLimit', - 'message' => 'The value of the usage parameter for the TLSA record is out of range.', - 'http_code' => 400, - 'description' => 'The value of the usage parameter for the TLSA record is out of range while creating or editing DNS record information.', - ], - [ - 'code' => 'Record.TTLExceedLimit', - 'message' => 'The TTL parameter value for a record is out of range.', - 'http_code' => 400, - 'description' => 'The TTL parameter value for a record is out of range while creating or editing DNS record information.', - ], - [ - 'code' => 'Record.TXTRecordValueExceedLimit', - 'message' => 'The TXT record value cannot exceed 450 characters.', - 'http_code' => 400, - 'description' => 'When you create or edit DNS record information, the TXT record value cannot exceed 450 characters.', - ], - [ - 'code' => 'Record.TypeExceedLimitWithSSHFPRecord', - 'message' => 'The SSHFP record Type parameter value is out of range.', - 'http_code' => 400, - 'description' => 'The SSHFP record Type parameter value is out of range while creating or editing DNS record information.', - ], - [ - 'code' => 'Record.UnmatchedRecordNameContainDoubleConsecutiveDot', - 'message' => 'Illegal host record name. The host record cannot contain consecutive dot.', - 'http_code' => 400, - 'description' => 'Illegal host record name. The host record cannot contain consecutive dot.', - ], - [ - 'code' => 'Record.UnmatchedRecordNameForbidStarSev', - 'message' => 'Illegal host record name, SRV record name disallowed asterisk.', - 'http_code' => 400, - 'description' => 'Illegal host record name, SRV record name disallowed asterisk.', - ], - [ - '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' => 'Illegal host record name. The \'@\' symbol can only appear at the top of the host record and can only be followed. Symbol, other strings are not allowed.', - ], - [ - 'code' => 'Record.UnmatchedRecordNameInvalidNamePrefixSuffix', - 'message' => 'Illegal host record name. Host record values cannot start or end with a dot, a hyphens.', - 'http_code' => 400, - 'description' => 'Illegal host record name. Host record values cannot start or end with a dot, a hyphens.', - ], - [ - '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' => '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.', - ], - [ - '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' => 'The host record name contains an illegal underscore. The underscore can only be used at the beginning of TXT, CAA, CNAME, NS, and SRV records. Proxy acceleration cannot be enabled and records can only be added in 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' => '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.', - ], - [ - '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' => 'The host record value cannot exist separately in various symbols, and can be added with any lowercase letters or numbers.'."\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' => 'The host record value cannot exist separately in various symbols, and can be added with any lowercase letters or numbers.', - ], - [ - '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' => 'Illegal host record character. Only lowercase a-z, uppercase A-Z, digits 0-9, \'-\', \'_\', \'.\', \'*\', and \'@\' are supported as valid characters in host records.', - ], - [ - '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' => 'Illegal host record name. The number of characters in each segment separated by \'.\' cannot exceed 63.', - ], - [ - 'code' => 'Record.UnsupportedSourceType', - 'message' => 'The recorded source station type is not in the supported range.', - 'http_code' => 400, - 'description' => 'The recorded source station type is not in the supported range.', - ], - [ - 'code' => 'Record.UnsupportedType', - 'message' => 'The record type parameter is unsupported.', - 'http_code' => 400, - 'description' => 'The record type parameter is incorrect. Please check the record type parameter.', - ], - [ - 'code' => 'Record.URIRecordPriorityExceedLimit', - 'message' => 'The value of the priority parameter for a URI record is out of range.', - 'http_code' => 400, - 'description' => 'The value of the priority parameter for a URI record is out of range while creating or editing DNS record information.', - ], - [ - 'code' => 'Record.URIRecordWeightExceedLimit', - 'message' => 'The URI record weight parameter value is out of range.', - 'http_code' => 400, - 'description' => 'The URI record weight parameter value is out of range while creating or editing DNS record information.', - ], - [ - 'code' => 'Record.ValidProxiedForSpecifedRecordType', - 'message' => 'Only A/AAAA and CNAME types support proxy acceleration.', - 'http_code' => 400, - 'description' => 'When creating or editing a record, proxy acceleration is enabled in the proxy state. Only A/AAAA and CNAME types support proxy acceleration.', - ], - [ - '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 records cannot add all and asterisk prefixed records at the same time.', - ], - [ - 'code' => 'Record.WildcartConflictForSpecifiedRecordType', - 'message' => 'The A/AAAA,CNAME records cannot add all and asterisk prefixed records at the same time.', - 'http_code' => 400, - 'description' => 'The A/AAAA,CNAME records cannot add all and asterisk prefixed records at the same time.', - ], - [ - 'code' => 'RecordNameInBalckList', - 'message' => 'The record name is in the blacklist.', - 'http_code' => 400, - 'description' => 'The record name is in the blacklist.', - ], - [ - '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' => '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.', - ], - [ - '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' => '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.', - ], - [ - 'code' => 'RelatedSiteNumberExceedQuotaLimit', - 'message' => 'The maximum number of websites that can be associated with the routine has been reached.', - 'http_code' => 400, - 'description' => 'The maximum number of websites that can be associated with the routine has been reached.', - ], - [ - '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' => 'Free certificates cannot be requested for a website that is not in the active state. Activate the website first.', - ], - [ - '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' => 'In order to protect the security of your account, the order was suspended, please contact customer service for details.', - ], - [ - 'code' => 'RoutineAlreadyExist', - 'message' => 'The routine name already exists.', - 'http_code' => 400, - 'description' => 'The routine name already exists.', - ], - [ - 'code' => 'RoutineCodeVersionStatusNotAvailable', - 'message' => 'The routine code version status not Available. Check the routine code version status and try again.', - 'http_code' => 400, - 'description' => 'The routine code version status is not Available. Check the status and try again.', - ], - [ - 'code' => 'RoutineNotExist', - 'message' => 'The routine name does not exist. Check the routine name and try again.', - 'http_code' => 400, - 'description' => 'The routine name does not exist. Check the routine name and try again.', - ], - [ - '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' => 'The maximum number of configuration items for the feature has been reached. Adjust your configurations and try again.', - ], - [ - 'code' => 'RoutineUserServiceStatusHalt', - 'message' => 'Failed to update the configurations because you have overdue payments.', - 'http_code' => 400, - 'description' => 'Failed to update the configurations because you have overdue payments.', - ], - [ - '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' => '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.', - ], - [ - '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' => '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.', - ], - [ - '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' => '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.', - ], - [ - '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' => 'The format of the rule configuration is invalid.Check the configuration for syntax errors or structural inconsistencies and correct them to meet the requirements.', - ], - [ - 'code' => 'Rule.Config.Noncompliance', - 'message' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', - 'http_code' => 403, - 'description' => 'The specified rule configuration does not meet the compliance requirements.Check and adjust your configurations.', - ], - [ - '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' => 'The specified rule name already exists.Try again with a unique name or modify the existing rule name.', - ], - [ - 'code' => 'Rule.NotExist', - 'message' => 'The specified rule does not exist.', - 'http_code' => 400, - 'description' => 'The specified rule does not exist in the current context or system configuration. Please verify the existence of the rule identifier and ensure it has been correctly defined or implemented.', - ], - [ - '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' => 'The specified position for the rule is invalid.Check and adjust the configuration to make sure it meets the requirements.', - ], - [ - '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' => 'Failed to compile the rule. Check your rule configurations and make sure they are in the valid format as described in the API documentation.', - ], - [ - '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' => 'The current plan does not support the configuration of a rule engine with a regular expression. Please check the plan description and upgrade your plan.', - ], - [ - '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' => 'The specified rule set name already exists.Try again with a unique name or modify the existing rule set name.', - ], - [ - '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' => '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.', - ], - [ - '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' => 'The maximum number of records with the same name added in batches exceeds 5. Add records with the same name in batches or reduce the number of records with the same name added in batches.', - ], - [ - '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' => 'The maximum number of scenario policies has been reached. Each account can create up to 10 scenario policies.', - ], - [ - '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' => 'Failed to call the service. Please try again later or contact customer service for details.', - ], - [ - 'code' => 'ServiceNotOpen', - 'message' => 'You have not activated Edge Routine. Activate the service and try again.', - 'http_code' => 400, - 'description' => 'You have not activated Edge Routine. Activate the service and try again.', - ], - [ - 'code' => 'Site.AlreadyExist', - 'message' => 'The website name you specified already exists. Try with another name.', - 'http_code' => 400, - 'description' => 'The website name you specified already exists. Try with another name.', - ], - [ - 'code' => 'Site.Conflict', - 'message' => 'Duplicate website names exist across multiple accounts. Rename or delete one and try again.', - 'http_code' => 400, - 'description' => 'Duplicate website names exist across multiple accounts. Rename or delete one and try again.', - ], - [ - 'code' => 'Site.InBlacklist', - 'message' => 'The site name is in the blacklist.', - 'http_code' => 400, - 'description' => 'The site name is in the blacklist.', - ], - [ - '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' => 'The selected location is unavailable in your plan. Change the location to one that is covered by the plan and try again.', - ], - [ - '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' => '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.', - ], - [ - 'code' => 'Site.NotSupportedStatus', - 'message' => 'The current site state is not supported.', - 'http_code' => 400, - 'description' => 'The current site state is not supported.', - ], - [ - 'code' => 'Site.ServiceBusy', - 'message' => 'This website is being configured. Try again later.', - 'http_code' => 400, - 'description' => 'This website is being configured. Try again later.', - ], - [ - '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' => '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.', - ], - [ - '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' => 'The size of the site configuration exceeds the limit, and the total size cannot exceed 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' => 'The environment name or rule conflicts with an existing environment. Try again with a different environment name or rule.', - ], - [ - 'code' => 'SiteEnvironment.DeleteDenied', - 'message' => 'The default environment cannot be deleted.', - 'http_code' => 400, - 'description' => 'The default environment cannot be deleted.', - ], - [ - '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' => 'You have entered an invalid site version environment, or the site does not have version management enabled. Please confirm that your version environment settings are correct, and activate the version management function if necessary, and then try again.', - ], - [ - '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' => '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.', - ], - [ - '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' => 'The current site has an existing four-layer accelerated application, and the current operation is not allowed. If necessary, please contact customer service.', - ], - [ - 'code' => 'SiteIdDDoSVersionCheckFailed', - 'message' => 'SiteId DDoS version check failed.', - 'http_code' => 403, - 'description' => 'Failed to check the DDoS version corresponding to the site.', - ], - [ - 'code' => 'SiteNotActivated', - 'message' => 'The site is not activated, the process is not allowed.', - 'http_code' => 400, - 'description' => 'The operation is not supported because the site is not activated.', - ], - [ - 'code' => 'SiteNotFound', - 'message' => 'The specified site is not found.', - 'http_code' => 400, - 'description' => 'The site you specified does not exist. Please check whether the site you entered is correct.', - ], - [ - 'code' => 'SiteNotFound', - 'message' => 'The website does not exist or does not belong to you.', - 'http_code' => 404, - 'description' => 'The website does not exist or does not belong to you.', - ], - [ - 'code' => 'SiteParameterNotMatch', - 'message' => 'Failed to verify website parameters.Check the parameters and try again.', - 'http_code' => 400, - 'description' => 'Failed to verify website parameters.Check the parameters and try again.', - ], - [ - 'code' => 'SiteVerify.Unpassed', - 'message' => 'Domain ownership verification failed. Complete the verification and try again.', - 'http_code' => 200, - 'description' => 'Domain ownership verification failed. Complete the verification and try again.', - ], - [ - 'code' => 'SiteVersion.Configuring', - 'message' => 'The version is being configured. Try again later.', - 'http_code' => 400, - 'description' => 'The version is being configured. Try again later.', - ], - [ - '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' => '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.', - ], - [ - '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' => '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.', - ], - [ - 'code' => 'SourceAddressInvalid', - 'message' => 'Invalid origin address. Check whether the IP address or domain name is in the valid format.', - 'http_code' => 400, - 'description' => 'Invalid origin address. Check whether the IP address or domain name is in the valid format.', - ], - [ - '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' => '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.', - ], - [ - 'code' => 'SourceInBlackList', - 'message' => 'The source is in the black list.', - 'http_code' => 400, - 'description' => 'The source is in the black list.', - ], - [ - 'code' => 'SourceNumberExceedLimit', - 'message' => 'The number of sources in the origin pool exceeds the quota limit.', - 'http_code' => 400, - 'description' => 'The number of sources that can be created in the origin pool has reached the upper limit of the package. Please check your package quota and upgrade the package to obtain more quota.', - ], - [ - 'code' => 'SourceTypeNotSupport', - 'message' => 'Invalid origin type. Valid values are ip_domain, OSS, FC, and S3.', - 'http_code' => 400, - 'description' => 'Invalid origin type. Valid values are ip_domain, OSS, FC, and 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' => 'Specifications exceed the limit, paid version can use 50ms, 100ms, free version can only use 5ms', - ], - [ - 'code' => 'SpecifiedVersionReadOnly', - 'message' => 'The specified version number is read-only and cannot be modified.', - 'http_code' => 400, - 'description' => 'The specified version number is read-only and cannot be modified.', - ], - [ - 'code' => 'SubSiteUnavailable', - 'message' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.', - 'http_code' => 400, - 'description' => 'Subdomains are allowed only in Enterprise plans. Upgrade your plan to add a subdomain to ESA.', - ], - [ - 'code' => 'SYSTEM.NoSpecificCodeFailed', - 'message' => 'Invalid subscription duration. Check and try again.', - 'http_code' => 400, - 'description' => 'Invalid subscription duration. Check and try again.', - ], - [ - 'code' => 'TooManyDimensions', - 'message' => 'Too many query dimensions specified. Delete some and try again.', - 'http_code' => 400, - 'description' => 'Too many query dimensions specified. Delete some and try again.', - ], - [ - 'code' => 'TooManyRequests', - 'message' => 'Too many requests.Please try again later.', - 'http_code' => 400, - 'description' => 'Requests are too frequent, please try again later.', - ], - [ - 'code' => 'TooManyRequests', - 'message' => 'Too many requests are submitted.', - 'http_code' => 429, - 'description' => 'Submissions are too frequent, please try again later', - ], - [ - 'code' => 'TooManyRequests', - 'message' => 'System load fluctuates, please try again later.', - 'http_code' => 429, - 'description' => 'System load fluctuates, please try again later.', - ], - [ - 'code' => 'TooQuickRequests', - 'message' => 'Request for putting or deleting keys are frequently submitted.', - 'http_code' => 429, - 'description' => 'The modification or deletion of key-value pairs is too frequent.', - ], - [ - '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' => 'The Layer -4 accelerated application conflicts with other applications. Check whether the application name and host record conflict with other applications in the site.', - ], - [ - 'code' => 'TransportLayerApplicationNotExist', - 'message' => 'The layer -4 accelerated application of the current operation does not exist. Modify it and try again.', - 'http_code' => 400, - 'description' => 'The layer -4 accelerated application of the current operation does not exist. Modify it and try again.', - ], - [ - 'code' => 'TransportLayerRulesExceedLimit', - 'message' => 'The configured forwarding rules have exceeded the maximum limit. Delete useless forwarding rules and try again.', - 'http_code' => 400, - 'description' => 'The configured forwarding rules have exceeded the maximum limit. Delete useless forwarding rules and try again.', - ], - [ - 'code' => 'TrialService.HasOpened', - 'message' => 'You have already activated the trial service.', - 'http_code' => 400, - 'description' => 'You have activated the trial service and cannot activate it again.', - ], - [ - 'code' => 'Unauthorized.InvalidParameters', - 'message' => 'The specified authentication parameters are invalid.', - 'http_code' => 403, - 'description' => 'Authentication parameter input error.', - ], - [ - 'code' => 'Unauthorized.InvalidTime', - 'message' => 'The specified authentication time is invalid.', - 'http_code' => 403, - 'description' => 'The authentication time parameter you entered is invalid. Check the parameter value and try again.', - ], - [ - 'code' => 'Unauthorized.InvalidToken', - 'message' => 'Token authentication failed.', - 'http_code' => 403, - 'description' => 'The token you entered is invalid. Please check and enter the correct token and try again.', - ], - [ - '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' => '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.', - ], - [ - 'code' => 'Unsupported.ConvertRecord', - 'message' => 'Converting site records is not supported in migration tasks.', - 'http_code' => 400, - 'description' => 'Converting site records is not supported in migration tasks.', - ], - [ - 'code' => 'Unsupported.DomainSourceConvertToRecord', - 'message' => 'Converting the domain sources to a site record is not supported in migration tasks.', - 'http_code' => 400, - 'description' => 'Converting the domain sources to a site record is not supported.', - ], - [ - 'code' => 'UnsupportQuota', - 'message' => 'Unsupported quota is specified. Check and try again.', - 'http_code' => 404, - 'description' => 'Unsupported quota is specified. Check and try again.', - ], - [ - 'code' => 'UpdateErServiceError', - 'message' => 'Failed to change the plan. You are only allowed to change your plan once within 24 hours.', - 'http_code' => 400, - 'description' => 'Failed to change the plan. You are only allowed to change your plan once within 24 hours.', - ], - [ - 'code' => 'UpdateFreeCertificate.NotSupport', - 'message' => 'The free certificate does not support the update operation.', - 'http_code' => 400, - 'description' => 'The free certificate does not support the update operation.', - ], - [ - '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' => 'The configuration for the upgrade or downgrade is not changed.', - ], - [ - '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' => 'You are calling an another routine related api. Please wait for the api finished, and try again later.', - ], - [ - 'code' => 'UserQuantityExceed', - 'message' => 'Your current purchase quantity exceeds the available quantity. Please select a new quantity.', - 'http_code' => 400, - 'description' => 'Your current purchase quantity exceeds the available quantity. Please select a new quantity.', - ], - [ - 'code' => 'UserWithoutConfLabel', - 'message' => 'Required tags missing. Configure tags and try again.', - 'http_code' => 400, - 'description' => 'Required tags missing. Configure tags and try again.', - ], - [ - 'code' => 'VerifyExpressionError', - 'message' => 'Dynamic expression is invalid.', - 'http_code' => 400, - 'description' => 'Dynamic expression is invalid.', - ], - [ - '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' => 'The NS verification failed. Please configure the NS provided by ESA on the domain name management platform and try again.', - ], - [ - 'code' => 'VersionNotValid', - 'message' => 'The site does not have version management enabled, or the version number passed in does not exist.', - 'http_code' => 400, - 'description' => 'The site does not have version management enabled, or the version number passed in does not exist.', - ], - [ - 'code' => 'WaitingRoomEventNotExist', - 'message' => 'The waiting room event that you want to modify does not exist. Specify a valid one.', - 'http_code' => 400, - 'description' => 'The waiting room event that you want to modify does not exist. Specify a valid one.', - ], - [ - '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' => 'The waiting room that you want to modify does not exist or does not belong to you. Confirm and try again.', - ], - [ - 'code' => 'WaitingRoomRuleNotExist', - 'message' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.', - 'http_code' => 400, - 'description' => 'The waiting room bypass rule that you want to modify does not exist. Specify a valid one.', - ], - [ - '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' => '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.', - ], - [ - 'code' => 'GitAccountNotExist', - 'message' => 'Git account does not exist.', - 'http_code' => 400, - 'description' => 'Git account does not exist.', - ], - [ - 'code' => 'InvalidRoutineBuildTaskStatus', - 'message' => 'Routine build configuration state that does not exist.', - 'http_code' => 400, - 'description' => 'Routine build configuration state that does not exist.', - ], - [ - 'code' => 'RoutineInstanceNotExist', - 'message' => 'The Routine instance does not exist.', - 'http_code' => 400, - 'description' => 'The Routine instance does not exist.', - ], - [ - 'code' => 'GitAccountAuthExpired', - 'message' => 'Git account authorization expired.', - 'http_code' => 400, - 'description' => 'Git account authorization expired.', - ], - [ - 'code' => 'GitAccountAlreadyExist', - 'message' => 'The Git account already exists and cannot be created repeatedly.', - 'http_code' => 400, - 'description' => 'The Git account already exists and cannot be created repeatedly.', - ], - [ - 'code' => 'GitAccountNotActive', - 'message' => 'Git account is not active.', - 'http_code' => 400, - 'description' => 'Git account is not active.', - ], - [ - 'code' => 'RoutineNotExist', - 'message' => 'Routine does not exist.', - 'http_code' => 400, - 'description' => 'Routine does not exist.', - ], - [ - 'code' => 'RoutineBuildTaskNotExist', - 'message' => 'Routine build task does not exist.', - 'http_code' => 400, - 'description' => 'Routine build task does not exist.', - ], - [ - 'code' => 'IllegalNodeVersion', - 'message' => 'NodeVersion parameter is illegal.', - 'http_code' => 400, - 'description' => 'NodeVersion parameter is illegal.', - ], - [ - 'code' => 'RoutineBuildConfigurationNotExist', - 'message' => 'Routine build configuration does not exist.', - 'http_code' => 400, - 'description' => 'Routine build configuration does not exist.', - ], - [ - 'code' => 'RoutineBuildConfigurationExist', - 'message' => 'Routine build configuration already exists.', - 'http_code' => 400, - 'description' => 'Routine build configuration already exists.', - ], - [ - 'code' => 'RoutineBuildTaskNotBuilding', - 'message' => 'The state of the Routine build task is not building.', - 'http_code' => 400, - 'description' => 'The state of the Routine build task is not building.', - ], - [ - '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' => 'The number of Git accounts exceeds the quota limit. A user can only associate up to 20 Git accounts.', - ], - [ - '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' => '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.', - ], - [ - 'code' => 'EnvironmentExceedLimit', - 'message' => 'The environment variable parameter exceeds the limit, and the number of keys and values exceeds the limit.', - 'http_code' => 400, - 'description' => 'The environment variable parameter exceeds the limit, and the number of keys and values exceeds the limit.', - ], - [ - 'code' => 'RepositoryExceedLimit', - 'message' => 'One code repository can only be associated with up to 10 Routine build configurations.', - 'http_code' => 400, - 'description' => 'One code repository can only be associated with up to 10 Routine build configurations.', - ], - [ - 'code' => 'CanNotOpenCrossBorderOptimization', - 'message' => 'Can not open cross border optimization.', - 'http_code' => 400, - 'description' => 'Can not open cross border optimization.', - ], - [ - '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' => 'The custom hostname conflicts with existing resources, such as sites, records, load balancers, source address pools, custom hostnames and Layer 4 proxy records.', - ], - [ - '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' => 'The number of custom hostnames exceeds the plan quota. Contact the sales team to increase your quota.', - ], - [ - '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' => 'The specified website does not have an ICP filing or the filing information is invalid. Make sure your website is filed and try again.', - ], - [ - 'code' => 'CustomHostname.VerifyUnpassed', - 'message' => 'The custom hostname ownership verification failed. Complete the verification and try again.', - 'http_code' => 200, - 'description' => 'The custom hostname ownership verification failed. Complete the verification and try again.', - ], - [ - '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' => 'Failed to delete the record because it is the source of existing custom hostnames.Remove all references to the record and try again.', - ], - [ - 'code' => 'CustomHostname.NotFound', - 'message' => 'The custom hostname does not exist. Modify it and try again.', - 'http_code' => 404, - 'description' => 'The custom hostname does not exist. Modify it and try again.', - ], - [ - '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' => 'Failed to delete the record because it is the origin server of existing custom hostnames.Remove all references to the record and try again.', - ], - [ - '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' => '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.', - ], - [ - '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' => '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.', - ], - [ - 'code' => 'CustomHostname.ServiceBusy', - 'message' => 'The custom hostname is being configured. Try again later.', - 'http_code' => 400, - 'description' => 'The custom hostname is being configured. Try again later.', - ], - [ - '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' => '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.', - ], - [ - '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' => '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.', - ], - [ - 'code' => 'ForbidUpdateSite.ConfigurationsUnclosed', - 'message' => 'If there are unclosed configurations, please close them before migrating.', - 'http_code' => 400, - 'description' => 'If there are unclosed configurations, please close them before migrating.', - ], - [ - 'code' => 'ForbidUpdateSite.PlanUnallowed', - 'message' => 'Site migration between preset plans and customized enterprise plans is not supported.', - 'http_code' => 400, - 'description' => 'Site migration between preset plans and customized enterprise plans is not supported.', - ], - [ - 'code' => 'SiteFunction.WafPageNotExist', - 'message' => 'The custom page referenced in the custom response code configuration does not exist.', - 'http_code' => 400, - 'description' => 'The custom page referenced in the custom response code configuration does not exist.', - ], - [ - 'code' => 'InvalidParameter_SchemaId', - 'message' => 'The parameter SchemaId is invalid.', - 'http_code' => 400, - 'description' => 'The parameter SchemaId is invalid.', - ], - [ - 'code' => 'InvalidParameter_IdentifierId', - 'message' => 'The parameter Identified is invalid.', - 'http_code' => 400, - 'description' => 'The parameter Identified is invalid.', - ], - [ - 'code' => 'InvalidParameter_SchemaNotFound', - 'message' => 'The parameter schemaId conf not found.', - 'http_code' => 400, - 'description' => 'The schema configuration corresponding to the input schemaId is not found.', - ], - [ - 'code' => 'InvalidParameter.ApiShieldQuota', - 'message' => 'This site does not have permission to manipulate API security features.', - 'http_code' => 400, - 'description' => 'This site does not have permission to manipulate API security features', - ], - [ - 'code' => 'InvalidParameter.RuleName', - 'message' => 'The parameter RuleName is invalid.', - 'http_code' => 400, - 'description' => 'The parameter RuleName is invalid.', - ], - [ - 'code' => 'InvalidParameter.EndpointIds', - 'message' => 'The parameter EndpointIds is invalid.', - 'http_code' => 400, - 'description' => 'The entry EndpointIds is illegal.', - ], - [ - 'code' => 'InvalidParameter.TokenConfigs', - 'message' => 'The parameter TokenConfigs is invalid.', - 'http_code' => 400, - 'description' => '', - ], - [ - 'code' => 'InvalidParameter.TokenConfigs.Tag', - 'message' => 'The parameter TokenConfigs.Tag is invalid.', - 'http_code' => 400, - 'description' => 'The parameter TokenConfigs_Tag is invalid.', - ], - [ - 'code' => 'InvalidParameter.RuleId', - 'message' => 'The parameter RuleId is invalid.', - 'http_code' => 400, - 'description' => 'The parameter RuleId is invalid', - ], - [ - 'code' => 'InvalidParameter.IdentifierId', - 'message' => 'The parameter IdentifierId is invalid.', - 'http_code' => 400, - 'description' => 'The parameter IdentifierId is invalid.', - ], - [ - 'code' => 'SameNameRecordExceedLimit', - 'message' => 'The number of records with the same name exceeds the upper limit.', - 'http_code' => 400, - 'description' => 'The number of records with the same name exceeds the upper limit.', - ], - [ - 'code' => 'InvalidParameter.RuleAction', - 'message' => 'The parameter RuleAction is invalid.', - 'http_code' => 400, - 'description' => 'The parameter RuleAction is invalid.', - ], - [ - 'code' => 'InvalidParameter.TokenValidateType', - 'message' => 'The parameter TokenValidateType is invalid.', - 'http_code' => 400, - 'description' => 'The parameter TokenValidateType is invalid.', - ], - [ - 'code' => 'InvalidParameter.TokenName', - 'message' => 'The parameter TokenName is invalid.', - 'http_code' => 400, - 'description' => 'The parameter TokenName is invalid.', - ], - [ - 'code' => 'InvalidParameter.ManagedApi.StateCanNotChanged', - 'message' => 'The status of the managed API is not allowed to be modified.', - 'http_code' => 400, - 'description' => 'The status of the managed API is not allowed to be modified.', - ], - [ - 'code' => 'InvalidParameter.TokenNameExists', - 'message' => 'The parameter TokenName already exists.', - 'http_code' => 400, - 'description' => 'The parameter TokenName already exists.', - ], - [ - 'code' => 'InvalidParameter.Identifier.Quota', - 'message' => 'The session identifier quota for the corresponding tier at the request site is insufficient.', - 'http_code' => 400, - 'description' => 'The session identifier quota for the corresponding tier at the request site is insufficient.', - ], - [ - 'code' => 'InvalidParameter.Credentials.Alg', - 'message' => 'The internal Alg field of the input parameter Credentials is invalid.', - 'http_code' => 400, - 'description' => 'The internal Alg field of the input parameter Credentials is invalid.', - ], - [ - 'code' => 'InvalidParameter.TokenUsed', - 'message' => 'The parameter TokenId token configuration is in use.', - 'http_code' => 400, - 'description' => 'The parameter TokenId token configuration is in use.', - ], - [ - 'code' => 'InvalidParameter.ManagedApi.Quota', - 'message' => 'The management API quota of the corresponding package of the request site exceeds the limit.', - 'http_code' => 400, - 'description' => 'The management API quota of the corresponding package of the request site exceeds the limit.', - ], - [ - 'code' => 'InvalidParameter.Position', - 'message' => 'The parameter Position is invalid.', - 'http_code' => 400, - 'description' => 'The parameter Position is invalid.', - ], - [ - 'code' => 'InvalidParameter.TokenId', - 'message' => 'The parameter TokenId is invalid.', - 'http_code' => 400, - 'description' => 'The parameter TokenId is invalid.', - ], - [ - 'code' => 'InvalidParameter.Credentials', - 'message' => 'The parameter Credentials is invalid.', - 'http_code' => 400, - 'description' => 'The parameter Credentials is invalid.', - ], - [ - 'code' => 'InvalidParameter.Credentials.KidRepeat', - 'message' => 'The internal field Kid of the input parameter Credentials is duplicate.', - 'http_code' => 400, - 'description' => 'The internal field Kid of the input parameter Credentials is duplicate.', - ], - [ - 'code' => 'InvalidParameter.Credentials.Kid', - 'message' => 'The internal field Kid of the input parameter Credentials is configured to be empty.', - 'http_code' => 400, - 'description' => 'The internal field Kid of the input parameter Credentials is configured to be empty.', - ], - [ - 'code' => 'InvalidParameter.TokenSources.Repeated', - 'message' => 'The input parameter TokenSources internal field configuration is duplicate.', - 'http_code' => 400, - 'description' => 'The input parameter TokenSources internal field configuration is duplicate.', - ], - [ - 'code' => 'InvalidParameter.TokenSources.Empty', - 'message' => 'The internal field of the input TokenSources is invalid.', - 'http_code' => 400, - 'description' => 'The internal field of the input TokenSources is invalid.', - ], - [ - 'code' => 'InvalidParameter.TokenSources', - 'message' => 'The parameter TokenSources is invalid.', - 'http_code' => 400, - 'description' => 'The parameter TokenSources is invalid.', - ], - [ - 'code' => 'InvalidParameter.TokenType', - 'message' => 'The parameter TokenType is invalid.', - 'http_code' => 400, - 'description' => 'The parameter TokenType is invalid.', - ], - [ - 'code' => 'InvalidParameter.SourceIpInBlacklist', - 'message' => 'The provided source is an invalid private IP address. Please verify and resubmit.', - 'http_code' => 400, - 'description' => 'The provided source is an invalid private IP address. Please verify and resubmit.', - ], - [ - 'code' => 'InvalidParameter.PrivateIpAsSourceUnsupported', - 'message' => 'The provided source is an invalid private IP address. Please verify and resubmit.', - 'http_code' => 400, - 'description' => 'The provided source is an invalid private IP address. Please verify and resubmit.', - ], - [ - 'code' => 'InvalidParameter.PrivateIpAsSourceUnsupported', - 'message' => 'The provided origin is an invalid private IP address. Please verify and resubmit.', - 'http_code' => 400, - 'description' => 'The provided origin is an invalid private IP address. Please verify and resubmit.', - ], - [ - 'code' => 'InvalidParameter.SourceIpInBlacklist', - 'message' => 'The provided origin is an invalid private IP address. Please verify and resubmit.', - 'http_code' => 400, - 'description' => 'The provided origin is an invalid private IP address. Please verify and resubmit.', - ], - [ - 'code' => 'InvalidParameter.ManagedApi.NotChanged', - 'message' => 'The status of the managed API is not allowed to be modified.', - 'http_code' => 400, - 'description' => 'The status of the managed API is not allowed to be modified.', - ], - [ - 'code' => 'InvalidParameter.ManagedApi.Quota', - 'message' => 'The API management quota of the corresponding package of the request site is insufficient.', - 'http_code' => 400, - 'description' => 'The API management quota of the corresponding package of the request site is insufficient.', - ], - [ - 'code' => 'InvalidParameter.Position', - 'message' => 'The input parameter Position is invalid.', - 'http_code' => 400, - 'description' => 'The input parameter Position is invalid.', - ], - [ - 'code' => 'InvalidParameter.ApiActions', - 'message' => 'The input parameter ApiActions is invalid.', - 'http_code' => 400, - 'description' => 'The input parameter ApiActions is invalid.', - ], - [ - 'code' => 'InvalidParameter.ApiRule.Quota', - 'message' => 'The API rule quota of the corresponding package of the request site is insufficient.', - 'http_code' => 400, - 'description' => 'The API rule quota of the corresponding package of the request site is insufficient.', - ], - [ - 'code' => 'InvalidParameter.RuleNameExists', - 'message' => 'The input parameter RuleName is duplicated.', - 'http_code' => 400, - 'description' => 'The input parameter RuleName is duplicated.', - ], - [ - 'code' => 'InvalidParameter.Token.Quota', - 'message' => 'The session token quota for the corresponding tier at the request site is insufficient.', - 'http_code' => 400, - 'description' => 'The session token quota for the corresponding tier at the request site is insufficient.', - ], - [ - 'code' => 'AmountExceed.Entranceplan', - 'message' => 'The parameter Amount exceeds the number of entrance plan that can be purchased.', - 'http_code' => 400, - 'description' => 'The parameter Amount exceeds the number of free versions that can be purchased.', - ], - [ - 'code' => 'FreePlanOrderUnpaid', - 'message' => 'Please complete your pending order for the free plan.', - 'http_code' => 400, - 'description' => 'Please complete your pending order for the free plan.', - ], - [ - 'code' => 'QuotaExceed.FreePlan', - 'message' => 'Your account has reached the maximum allowed quota for free plan purchases.', - 'http_code' => 400, - 'description' => 'Your account has reached the maximum allowed quota for free plan purchases.', - ], - [ - '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' => 'Illegal host record character. Only lowercase a-z, uppercase A- Z, digits 0-9, \'-\', \'_\', \'.\', \'*\', and \'@\' are supported as valid characters in host records \',\' @ \'.'."\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' => 'When you create or edit a CAA record, if the Tag is `iodef` and the Value starts with `http://` or `https://`, it must be followed by a valid URL.', - ], - [ - 'code' => 'IPA.FunctionConflict', - 'message' => 'KeepAliveProtection is conflicted with StaticIp and CrossBorderOptimization are conflict, can not open at same time.', - 'http_code' => 400, - 'description' => 'KeepAliveProtection is conflicted with StaticIp and CrossBorderOptimization are conflict, can not open at same time', - ], - [ - '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 protection specifications for mainland China and non-mainland China cannot be used as basic protection.', - ], - [ - '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' => 'The site has one or more IPA apps with keep-alive-protection enabled, so it cannot update the coverage or the instance.', - ], - [ - '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' => '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."', - ], - [ - 'code' => 'IPA.KeepAliveProtectionConflict', - 'message' => 'KeepAliveProtection is conflicted with StaticIp and CrossBorderOptimization, can not open at same time.', - 'http_code' => 400, - 'description' => 'KeepAliveProtection is conflicted with StaticIp and CrossBorderOptimization, can not open at same time', - ], - [ - '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' => 'You have an unpaid ESA order. Please complete or void the order at the User Center before placing another order.', - ], - [ - 'code' => 'InvalidParameter.ApiShieldSellVerison', - 'message' => 'The site does not have permissions to manipulate the enterprise-level capabilities of API security features.', - 'http_code' => 400, - 'description' => 'The site does not have permissions to manipulate the enterprise-level capabilities of API security features.', - ], - [ - 'code' => 'SiteHasCrossBorderOptimization', - 'message' => 'Chinese Mainland Network is enabled for this site. Please disable Chinese Mainland Network and try again.', - 'http_code' => 400, - 'description' => 'Network acceleration in mainland China is enabled for this site. Turn off network acceleration in mainland China and try again.', - ], - [ - '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' => '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.', - ], - [ - 'code' => 'SiteHasCustomPorts', - 'message' => 'Custom ports is enabled for this site. Please disable custom ports and try again.', - 'http_code' => 400, - 'description' => 'A custom port has been opened in the site. Close the custom port and try again.', - ], - [ - 'code' => 'FunctionArgError', - 'message' => 'Failed to check the configured function parameters.', - 'http_code' => 400, - 'description' => 'Failed to check the configured function parameters', - ], - [ - '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' => 'The ER build task does not exist or does not match the user, please check that it is correct and try again.', - ], - [ - 'code' => 'OriginPool.TypeNotSupport', - 'message' => 'The origin address pool type is not supported.', - 'http_code' => 400, - 'description' => 'The origin address pool type is not supported.', - ], - [ - 'code' => 'Site.NotActive', - 'message' => 'The status of the applied site or site is not activated.', - 'http_code' => 400, - 'description' => 'The status of the applied site or site is not activated.', - ], - [ - 'code' => 'CustomHostname.ApplyCertFailed', - 'message' => 'Fail to apply a free cert for custom hostname. Please try again later.', - 'http_code' => 400, - 'description' => 'Fail to apply a free cert for custom hostname. Please try again later.', - ], - [ - 'code' => 'CustomHostname.SetCertFailed', - 'message' => 'Fail to deploy a cert for custom hostname. Please try again later.', - 'http_code' => 400, - 'description' => 'Fail to deploy a cert for custom hostname. Please try again later.', - ], - [ - 'code' => 'ConfigNotFound', - 'message' => 'The specified configuration does not exist.', - 'http_code' => 400, - 'description' => 'The specified configuration does not exist.', - ], - [ - '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' => 'The ER build task does not exist or does not match the user, please check that it is correct and try again.', - ], - [ - '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' => 'The current package does not support configuring custom ports. Please check the package description and upgrade your package.', - ], - [ - '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' => 'Invalid port. Enter a valid port as required by the interface documentation.', - ], - [ - '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' => 'The instance site count quota is full.', - ], - [ - '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' => 'The number of recorded ports exceeds the limit, including 80 or 443 ports. A maximum of 21 ports are supported. Please adjust and try again.', - ], - [ - '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' => '', - ], - [ - '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' => '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.', - ], - [ - 'code' => 'Ato.ApiAsset.NotExist', - 'message' => 'The specified ATO API asset does not exist.', - 'http_code' => 400, - 'description' => 'The specified account security API asset does not exist in the current context or system configuration. Please confirm the existence of the API asset identifier and make sure it is properly defined or implemented.', - ], - [ - 'code' => 'Ato.ProtectionStrategy.NotExist', - 'message' => 'The specified ATO protection strategy does not exist.', - 'http_code' => 400, - 'description' => 'The specified account security policy does not exist in the current context or system configuration. Verify the existence of the protection policy identifier and ensure that it has been properly defined or implemented.', - ], - [ - 'code' => 'Ato.ProtectionStrategy.BeingBound', - 'message' => 'The specified ATO protection strategy is being bound.', - 'http_code' => 400, - 'description' => 'the specified account security policy is bound by one or more protection rules.', - ], - ], - 'changeSet' => [ - [ - 'apis' => [ - [ - 'description' => 'Response parameters changed', - 'api' => 'SetClientCertificateHostnames', - ], - ], - 'createdAt' => '2025-03-13T09:11:33.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Response parameters changed', - 'api' => 'ListScheduledPreloadJobs', - ], - ], - 'createdAt' => '2025-03-13T08:02:30.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'BlockObject', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'PreloadCaches', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'PurgeCaches', - ], - ], - 'createdAt' => '2025-03-13T07:59:15.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Response parameters changed', - 'api' => 'GetClientCaCertificate', - ], - [ - 'description' => 'Response parameters changed', - 'api' => 'GetClientCertificate', - ], - [ - 'description' => 'Response parameters changed', - 'api' => 'ListClientCaCertificates', - ], - [ - 'description' => 'Response parameters changed', - 'api' => 'ListClientCertificates', - ], - ], - 'createdAt' => '2025-03-12T03:31:00.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Request parameters changed', - 'api' => 'UpdateCustomScenePolicy', - ], - ], - 'createdAt' => '2025-03-12T02:37:17.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Response parameters changed', - 'api' => 'CreateSiteDeliveryTask', - ], - ], - 'createdAt' => '2025-02-28T07:45:05.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Request parameters changed', - 'api' => 'CreateOriginRule', - ], - [ - 'description' => 'Response parameters changed', - 'api' => 'GetOriginRule', - ], - [ - 'description' => 'Response parameters changed', - 'api' => 'ListOriginRules', - ], - [ - 'description' => 'Request parameters changed', - 'api' => 'UpdateOriginRule', - ], - ], - 'createdAt' => '2025-02-27T09:17:23.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Response parameters changed', - 'api' => 'GetWafFilter', - ], - ], - 'createdAt' => '2025-02-27T08:45:59.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'DeleteOriginProtection', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'UpdateOriginProtection', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'UpdateOriginProtectionIpWhiteList', - ], - ], - 'createdAt' => '2025-02-21T06:59:44.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Request parameters changed', - 'api' => 'UpdateWaitingRoomEvent', - ], - [ - 'description' => 'Request parameters changed', - 'api' => 'UpdateWaitingRoomRule', - ], - ], - 'createdAt' => '2025-02-21T03:41:24.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Request parameters changed', - 'api' => 'DeleteWaitingRoomEvent', - ], - [ - 'description' => 'Request parameters changed', - 'api' => 'DeleteWaitingRoomRule', - ], - [ - 'description' => 'Response parameters changed', - 'api' => 'ListCacheReserveInstances', - ], - ], - 'createdAt' => '2025-02-21T03:26:42.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed, Request parameters changed', - 'api' => 'PurchaseRatePlan', - ], - ], - 'createdAt' => '2025-02-20T05:45:43.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Request parameters changed', - 'api' => 'DescribeCustomScenePolicies', - ], - ], - 'createdAt' => '2025-02-19T08:09:11.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'BatchCreateRecords', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'CreateRecord', - ], - [ - 'description' => 'Response parameters changed', - 'api' => 'GetSite', - ], - [ - 'description' => 'Response parameters changed', - 'api' => 'ListSites', - ], - ], - 'createdAt' => '2025-02-18T05:59:56.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Request parameters changed', - 'api' => 'SetCertificate', - ], - ], - 'createdAt' => '2025-02-13T01:37:48.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Request parameters changed', - 'api' => 'CreateLoadBalancer', - ], - [ - 'description' => 'Response parameters changed', - 'api' => 'ListLoadBalancers', - ], - [ - 'description' => 'Request parameters changed', - 'api' => 'UpdateLoadBalancer', - ], - ], - 'createdAt' => '2025-02-13T01:35:09.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Request parameters changed', - 'api' => 'CreateCompressionRule', - ], - [ - 'description' => 'Response parameters changed', - 'api' => 'GetCompressionRule', - ], - [ - 'description' => 'Response parameters changed', - 'api' => 'ListCompressionRules', - ], - [ - 'description' => 'Request parameters changed', - 'api' => 'UpdateCompressionRule', - ], - ], - 'createdAt' => '2025-02-12T02:26:24.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Response parameters changed', - 'api' => 'CreateWaitingRoom', - ], - [ - 'description' => 'Response parameters changed', - 'api' => 'CreateWaitingRoomEvent', - ], - [ - 'description' => 'Response parameters changed', - 'api' => 'CreateWaitingRoomRule', - ], - [ - 'description' => 'Request parameters changed, Response parameters changed', - 'api' => 'ListUserRatePlanInstances', - ], - ], - 'createdAt' => '2025-02-12T02:01:47.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Request parameters changed', - 'api' => 'DescribePurgeTasks', - ], - [ - 'description' => 'Request parameters changed', - 'api' => 'GetPurgeQuota', - ], - [ - 'description' => 'Request parameters changed', - 'api' => 'PurgeCaches', - ], - ], - 'createdAt' => '2025-02-10T01:56:01.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Request parameters changed', - 'api' => 'CreateLoadBalancer', - ], - ], - 'createdAt' => '2025-02-10T01:26:43.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'DeleteSite', - ], - [ - 'description' => 'Response parameters changed', - 'api' => 'ListUserRatePlanInstances', - ], - ], - 'createdAt' => '2025-01-10T01:52:00.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Request parameters changed', - 'api' => 'ListPages', - ], - ], - 'createdAt' => '2025-01-09T06:25:18.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Response parameters changed', - 'api' => 'SetCertificate', - ], - ], - 'createdAt' => '2025-01-09T05:45:30.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'ListManagedRulesGroups', - ], - [ - 'description' => 'Request parameters changed', - 'api' => 'UpdatePage', - ], - ], - 'createdAt' => '2024-12-26T15:08:05.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Request parameters changed', - 'api' => 'CreateUserDeliveryTask', - ], - [ - 'description' => 'Response parameters changed', - 'api' => 'GetUserDeliveryTask', - ], - [ - 'description' => 'Request parameters changed', - 'api' => 'UpdateUserDeliveryTask', - ], - ], - 'createdAt' => '2024-12-26T08:22:34.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Request parameters changed', - 'api' => 'GetOriginProtection', - ], - ], - 'createdAt' => '2024-12-24T01:43:07.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'EditSiteWafSettings', - ], - ], - 'createdAt' => '2024-12-19T09:11:02.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Request parameters changed', - 'api' => 'GetSiteWafSettings', - ], - [ - 'description' => 'Request parameters changed', - 'api' => 'ListWafRules', - ], - ], - 'createdAt' => '2024-12-12T06:19:10.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed, Request parameters changed', - 'api' => 'PurgeCaches', - ], - ], - 'createdAt' => '2024-12-06T02:12:12.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Request parameters changed', - 'api' => 'CommitRoutineStagingCode', - ], - [ - 'description' => 'Request parameters changed', - 'api' => 'CreateRoutine', - ], - [ - 'description' => 'Request parameters changed', - 'api' => 'CreateRoutineRelatedRecord', - ], - [ - 'description' => 'Request parameters changed', - 'api' => 'CreateRoutineRelatedRoute', - ], - [ - 'description' => 'Request parameters changed', - 'api' => 'DeleteRoutine', - ], - [ - 'description' => 'Request parameters changed', - 'api' => 'DeleteRoutineCodeVersion', - ], - [ - 'description' => 'Request parameters changed', - 'api' => 'DeleteRoutineRelatedRecord', - ], - [ - 'description' => 'Request parameters changed', - 'api' => 'DeleteRoutineRelatedRoute', - ], - [ - 'description' => 'Request parameters changed, Response parameters changed', - 'api' => 'GetRoutine', - ], - [ - 'description' => 'Request parameters changed', - 'api' => 'GetRoutineStagingCodeUploadInfo', - ], - ], - 'createdAt' => '2024-12-04T05:50:49.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Request parameters changed, Response parameters changed', - 'api' => 'CreateSiteFunction', - ], - [ - 'description' => 'Response parameters changed', - 'api' => 'ListSiteFunctions', - ], - [ - 'description' => 'Request parameters changed', - 'api' => 'UpdateSiteFunction', - ], - ], - 'createdAt' => '2024-12-04T02:33:41.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Request parameters changed, Response parameters changed', - 'api' => 'ListSites', - ], - [ - 'description' => 'Request parameters changed', - 'api' => 'ListUserRatePlanInstances', - ], - ], - 'createdAt' => '2024-11-28T06:42:15.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'GetKv', - ], - ], - 'createdAt' => '2024-11-26T03:44:10.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Response parameters changed', - 'api' => 'DescribeDDoSAllEventList', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'DescribeHttpDDoSAttackIntelligentProtection', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'DescribeHttpDDoSAttackProtection', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'SetHttpDDoSAttackIntelligentProtection', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'SetHttpDDoSAttackProtection', - ], - ], - 'createdAt' => '2024-11-19T03:36:10.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Request parameters changed', - 'api' => 'ListRecords', - ], - ], - 'createdAt' => '2024-11-19T01:42:35.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Request parameters changed', - 'api' => 'ListWafManagedRules', - ], - [ - 'description' => 'Request parameters changed', - 'api' => 'ListWafTemplateRules', - ], - ], - 'createdAt' => '2024-11-12T07:31:28.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed, Request parameters changed', - 'api' => 'BatchCreateRecords', - ], - [ - 'description' => 'Response parameters changed', - 'api' => 'ListUserRatePlanInstances', - ], - ], - 'createdAt' => '2024-11-12T05:58:05.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Request parameters changed', - 'api' => 'CreateScheduledPreloadExecutions', - ], - ], - 'createdAt' => '2024-11-12T03:12:55.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Response parameters changed', - 'api' => 'GetEdgeContainerAppVersion', - ], - [ - 'description' => 'Response parameters changed', - 'api' => 'ListEdgeContainerAppVersions', - ], - ], - 'createdAt' => '2024-11-12T02:07:43.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'CommitRoutineStagingCode', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'CreateRoutine', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'CreateRoutineRelatedRecord', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'CreateRoutineRelatedRoute', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'DeleteRoutine', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'DeleteRoutineCodeVersion', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'DeleteRoutineRelatedRecord', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'DeleteRoutineRelatedRoute', - ], - ], - 'createdAt' => '2024-11-05T06:55:41.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'CreateRecord', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'UpdateSiteAccessType', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'UpdateSiteVanityNS', - ], - ], - 'createdAt' => '2024-11-05T03:28:14.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'CheckUserProjectName', - ], - [ - 'description' => 'Error codes changed, Request parameters changed', - 'api' => 'CreateSiteDeliveryTask', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'CreateUserDeliveryTask', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'DeleteSiteDeliveryTask', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'DeleteUserDeliveryTask', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'GetUserDeliveryTask', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'ListUserDeliveryTasks', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'UpdateSiteDeliveryTask', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'UpdateUserDeliveryTask', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'UpdateUserDeliveryTaskStatus', - ], - ], - 'createdAt' => '2024-10-18T01:07:45.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'ListInstanceQuotas', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'ListInstanceQuotasWithUsage', - ], - ], - 'createdAt' => '2024-10-15T09:24:31.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'UpdateSiteCoverage', - ], - ], - 'createdAt' => '2024-10-15T05:53:31.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'ListEdgeContainerApps', - ], - ], - 'createdAt' => '2024-10-15T03:49:31.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'SetCertificate', - ], - ], - 'createdAt' => '2024-10-15T03:45:45.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'PreloadCaches', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'PurgeCaches', - ], - ], - 'createdAt' => '2024-10-15T01:59:01.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'BatchCreateRecords', - ], - ], - 'createdAt' => '2024-10-11T06:14:16.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed, Request parameters changed', - 'api' => 'CreateRecord', - ], - [ - 'description' => 'Error codes changed, Request parameters changed', - 'api' => 'UpdateRecord', - ], - ], - 'createdAt' => '2024-10-10T12:01:55.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'ListInstanceQuotasWithUsage', - ], - ], - 'createdAt' => '2024-10-10T07:17:08.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'CreateSite', - ], - ], - 'createdAt' => '2024-10-10T02:02:02.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'CreateSite', - ], - ], - 'createdAt' => '2024-10-08T03:27:01.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'SetCertificate', - ], - ], - 'createdAt' => '2024-10-03T13:49:15.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Request parameters changed, Response parameters changed', - 'api' => 'ListManagedRulesGroups', - ], - ], - 'createdAt' => '2024-09-29T05:47:36.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'CheckSiteProjectName', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'CheckUserProjectName', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'CreateSiteCustomLog', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'CreateSiteDeliveryTask', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'CreateUserDeliveryTask', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'DeleteSiteDeliveryTask', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'DeleteUserDeliveryTask', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'GetRealtimeDeliveryField', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'GetSiteCustomLog', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'GetSiteDeliveryTask', - ], - ], - 'createdAt' => '2024-09-27T05:57:43.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'BatchCreateWafRules', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'BatchGetExpressionFields', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'BatchUpdateWafRules', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'CreateList', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'CreatePage', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'CreateWafRule', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'DeleteList', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'DeletePage', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'DeleteWafRule', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'DeleteWafRuleset', - ], - ], - 'createdAt' => '2024-09-25T07:03:22.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed, Request parameters changed', - 'api' => 'ListLists', - ], - ], - 'createdAt' => '2024-09-25T07:02:13.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'UpdateSiteCoverage', - ], - ], - 'createdAt' => '2024-09-24T09:14:10.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Request parameters changed', - 'api' => 'CreateSiteDeliveryTask', - ], - [ - 'description' => 'Request parameters changed', - 'api' => 'CreateUserDeliveryTask', - ], - ], - 'createdAt' => '2024-09-24T08:32:17.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'BatchCreateRecords', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'CreateRecord', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'UpdateRecord', - ], - ], - 'createdAt' => '2024-09-24T08:28:53.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'BlockObject', - ], - ], - 'createdAt' => '2024-09-24T06:04:45.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed, Request parameters changed', - 'api' => 'CreateRecord', - ], - [ - 'description' => 'Error codes changed, Response parameters changed', - 'api' => 'GetRecord', - ], - [ - 'description' => 'Error codes changed, Response parameters changed', - 'api' => 'ListRecords', - ], - [ - 'description' => 'Error codes changed, Request parameters changed', - 'api' => 'UpdateRecord', - ], - ], - 'createdAt' => '2024-09-23T08:54:00.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed, Request parameters changed', - 'api' => 'ListSites', - ], - ], - 'createdAt' => '2024-09-23T07:17:24.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'BatchUpdateWafRules', - ], - ], - 'createdAt' => '2024-09-23T06:20:25.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'ActivateClientCertificate', - ], - ], - 'createdAt' => '2024-09-23T02:16:50.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'BatchDeleteKv', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'BatchDeleteKvWithHighCapacity', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'BatchPutKv', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'BatchPutKvWithHighCapacity', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'GetKvNamespace', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'ListKvs', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'PutKv', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'PutKvAccount', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'PutKvWithHighCapacity', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'UpdateKvNamespace', - ], - ], - 'createdAt' => '2024-09-20T13:50:13.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'CreateList', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'CreateManagedRulesGroup', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'CreatePage', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'SetCertificate', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'UpdateList', - ], - ], - 'createdAt' => '2024-09-18T09:54:23.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'CheckSiteName', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'EditSiteWafSettings', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'ExportRecords', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'GetList', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'GetManagedRulesGroup', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'GetSite', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'GetSiteCurrentNS', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'GetSiteWafSettings', - ], - ], - 'createdAt' => '2024-09-18T08:57:12.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'GetWafBotAppKey', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'GetWafFilter', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'GetWafQuota', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'GetWafRuleset', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'ListEdgeContainerAppRecords', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'ListEdgeContainerRecords', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'ListEdgeRoutineRecords', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'ListLists', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'ListManagedRulesGroups', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'ListPages', - ], - ], - 'createdAt' => '2024-09-18T08:07:13.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - 'api' => 'BatchCreateRecords', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'BatchCreateWafRules', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'BatchGetExpressionFields', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'BatchUpdateWafRules', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'ListTagResources', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'ListWafPhases', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'ListWafRulesets', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'ListWafTemplateRules', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'ListWafUsageOfRules', - ], - [ - 'description' => 'Error codes changed', - 'api' => 'ListWaitingRoomEvents', - ], - ], - 'createdAt' => '2024-09-18T06:14:20.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Error codes changed', - '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' => 'Edge Security Acceleration', - 'ramCodes' => [ - 'esa', - ], - 'ramLevel' => 'RESOURCE', - 'ramConditions' => [], - 'ramActions' => [ - [ - 'apiName' => 'CreateWafRuleset', - 'description' => '', - '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' => 'All Resource', - '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' => '', - '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' => '', - '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' => '', - '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' => 'All Resource', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'DescribeRatePlanInstanceStatus', - 'description' => '', - 'operationType' => 'create', - 'ramAction' => [ - 'action' => 'esa:DescribeRatePlanInstanceStatus', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'DescribeSiteTopData', - 'description' => '', - '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' => 'All Resource', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'GetEdgeContainerLogs', - 'description' => '', - 'operationType' => 'get', - 'ramAction' => [ - 'action' => 'esa:GetEdgeContainerLogs', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'ListCiphers', - 'description' => '', - 'operationType' => 'list', - 'ramAction' => [ - 'action' => 'esa:ListCiphers', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'GetUserLogDeliveryQuota', - 'description' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:GetUserLogDeliveryQuota', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'GetEdgeContainerTerminal', - 'description' => '', - 'operationType' => 'get', - 'ramAction' => [ - 'action' => 'esa:GetEdgeContainerTerminal', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'UpdateOriginProtectionIpWhiteList', - 'description' => '', - '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' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'CheckSiteProjectName', - 'description' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:CheckSiteProjectName', - 'authLevel' => 'resource', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'SetHttpDDoSAttackIntelligentProtection', - 'description' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'DescribeHttpDDoSAttackProtection', - 'description' => '', - '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' => '', - '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' => '', - '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' => '', - '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' => 'All Resource', - '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' => '', - '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' => '', - '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' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'UpdateRoutineConfigDescription', - 'description' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:UpdateRoutineConfigDescription', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'UpdateRatePlanSpec', - 'description' => '', - 'operationType' => 'create', - 'ramAction' => [ - 'action' => 'esa:UpdateRatePlanSpec', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => '', - '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' => '', - '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' => '', - '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' => '', - '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' => '', - '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' => 'All Resource', - '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' => 'All Resource', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'VerifyCustomHostname', - 'description' => '', - 'operationType' => 'update', - 'ramAction' => [ - 'action' => 'esa:VerifyCustomHostname', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'DeleteUserDeliveryTask', - 'description' => '', - 'operationType' => 'delete', - 'ramAction' => [ - 'action' => 'esa:DeleteUserDeliveryTask', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => 'All Resource', - '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' => 'All Resource', - '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' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:CreateUserWafRuleset', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'GetWafRule', - 'description' => '', - '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' => 'All Resource', - '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' => 'All Resource', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'DeleteKvNamespace', - 'description' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:DeleteKvNamespace', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'ListClientCaCertificates', - 'description' => '', - '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' => '', - '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' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:ListKvs', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'GetWafBotAppKey', - 'description' => '', - 'operationType' => 'get', - 'ramAction' => [ - 'action' => 'esa:GetWafBotAppKey', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'UpdateHttpRequestHeaderModificationRule', - 'description' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'GetKvDetail', - 'description' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:GetKvDetail', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'ListWafManagedRules', - 'description' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'GetRoutineStagingCodeUploadInfo', - 'description' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:GetRoutineStagingCodeUploadInfo', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'BatchPutKv', - 'description' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:BatchPutKv', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'UpdateCnameFlattening', - 'description' => '', - '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' => '', - 'operationType' => 'get', - 'ramAction' => [ - 'action' => 'esa:GetUserWafRuleset', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => '', - 'operationType' => 'delete', - 'ramAction' => [ - 'action' => 'esa:DeleteCustomHostname', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'UpdateRecord', - 'description' => '', - 'operationType' => 'update', - 'ramAction' => [ - 'action' => 'esa:UpdateRecord', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'ListManagedRulesGroups', - 'description' => '', - 'operationType' => 'list', - 'ramAction' => [ - 'action' => 'esa:ListManagedRulesGroups', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => '', - 'operationType' => 'get', - 'ramAction' => [ - 'action' => 'esa:GetCustomHostname', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'GetWafQuota', - 'description' => '', - 'operationType' => 'get', - 'ramAction' => [ - 'action' => 'esa:GetWafQuota', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'GetKvAccount', - 'description' => '', - 'operationType' => 'get', - 'ramAction' => [ - 'action' => 'esa:GetKvAccount', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'GetHttpsApplicationConfiguration', - 'description' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'DescribeDdosMaxBurstGbps', - 'description' => '', - 'operationType' => 'get', - 'ramAction' => [ - 'action' => 'esa:DescribeDdosMaxBurstGbps', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'DeleteRoutineCodeVersion', - 'description' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:DeleteRoutineCodeVersion', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'ListEdgeContainerAppRecords', - 'description' => '', - 'operationType' => 'list', - 'ramAction' => [ - 'action' => 'esa:ListEdgeContainerAppRecords', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:BatchDeleteKvWithHighCapacity', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'ListUserRoutines', - 'description' => '', - 'operationType' => 'list', - 'ramAction' => [ - 'action' => 'esa:ListUserRoutines', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => '', - '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' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:BatchPutKvWithHighCapacity', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'SetHttpDDoSAttackRuleStatus', - 'description' => '', - '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' => 'All Resource', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'UpdateWafRuleset', - 'description' => '', - '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' => '', - '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' => 'All Resource', - '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' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:DeleteUserWafRuleset', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => '', - 'operationType' => 'delete', - 'ramAction' => [ - 'action' => 'esa:DeleteRecord', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => '', - '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' => 'All Resource', - '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' => '', - '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' => '', - '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' => '', - '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' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'DeleteHttpResponseHeaderModificationRule', - 'description' => '', - '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' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:ListUserWafRulesets', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => '', - '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' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'DeleteWafRule', - 'description' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'PutKv', - 'description' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:PutKv', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'CreateKvNamespace', - 'description' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:CreateKvNamespace', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'GetRoutineCodeVersion', - 'description' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:GetRoutineCodeVersion', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'UpdateCacheReserveSpec', - 'description' => '', - 'operationType' => 'create', - 'ramAction' => [ - 'action' => 'esa:UpdateCacheReserveSpec', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'GetEdgeContainerAppResourceReserve', - 'description' => '', - 'operationType' => 'get', - 'ramAction' => [ - 'action' => 'esa:GetEdgeContainerAppResourceReserve', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => '', - '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' => 'All Resource', - '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' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:GetKv', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'ListRoutineRoutes', - 'description' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:ListRoutineRoutes', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'DeleteCustomScenePolicy', - 'description' => '', - 'operationType' => 'delete', - 'ramAction' => [ - 'action' => 'esa:DeleteCustomScenePolicy', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'GetIPv6', - 'description' => '', - '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' => 'All Resource', - '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' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'ResetScheduledPreloadJob', - 'description' => '', - 'operationType' => 'update', - 'ramAction' => [ - 'action' => 'esa:ResetScheduledPreloadJob', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'DisableCustomScenePolicy', - 'description' => '', - 'operationType' => 'get', - 'ramAction' => [ - 'action' => 'esa:DisableCustomScenePolicy', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => '', - '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' => '', - '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' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'ListCustomHostnames', - 'description' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'SetDdosMaxBurstGbps', - 'description' => '', - 'operationType' => 'create', - 'ramAction' => [ - 'action' => 'esa:SetDdosMaxBurstGbps', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'GetEdgeContainerApp', - 'description' => '', - 'operationType' => 'get', - 'ramAction' => [ - 'action' => 'esa:GetEdgeContainerApp', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => 'All Resource', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'UpdateScheduledPreloadExecution', - 'description' => '', - 'operationType' => 'update', - 'ramAction' => [ - 'action' => 'esa:UpdateScheduledPreloadExecution', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'GetHttpIncomingResponseHeaderModificationRule', - 'description' => '', - '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' => '', - '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' => 'All Resource', - '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' => '', - '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' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'PreloadCaches', - 'description' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'DeleteHttpIncomingResponseHeaderModificationRule', - 'description' => '', - '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' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'GetWafFilter', - 'description' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'UpdateHttpIncomingResponseHeaderModificationRule', - 'description' => '', - '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' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:BatchDeleteKv', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'DeleteClientCaCertificate', - 'description' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'GetEdgeContainerStagingDeployStatus', - 'description' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:GetEdgeContainerStagingDeployStatus', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => '', - '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' => '', - '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' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'CreateRoutine', - 'description' => '', - 'operationType' => 'create', - 'ramAction' => [ - 'action' => 'esa:CreateRoutine', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => '', - 'operationType' => 'get', - 'ramAction' => [ - 'action' => 'esa:GetKvNamespace', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'GetRecord', - 'description' => '', - 'operationType' => 'get', - 'ramAction' => [ - 'action' => 'esa:GetRecord', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'ListLoadBalancerRegions', - 'description' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:ListLoadBalancerRegions', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'GetEdgeContainerAppStatus', - 'description' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:GetEdgeContainerAppStatus', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'DescribeDDoSAllEventList', - 'description' => '', - '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' => '', - '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' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'CheckUserProjectName', - 'description' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:CheckUserProjectName', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => '', - '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' => 'All Resource', - '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' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:PutKvWithHighCapacity', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'CreateHttpsBasicConfiguration', - 'description' => '', - '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' => 'All Resource', - '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' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'UpdateHttpResponseHeaderModificationRule', - 'description' => '', - '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' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:ListRoutineCodeVersions', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => '', - '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' => '', - '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' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:DeleteKv', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'ListHttpsBasicConfigurations', - 'description' => '', - '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' => '', - 'operationType' => 'update', - 'ramAction' => [ - 'action' => 'esa:ApplyCustomHostnameCertificate', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'BatchCreateWafRules', - 'description' => '', - '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' => 'All Resource', - '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' => '', - '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' => '', - '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' => 'All Resource', - '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' => '', - 'operationType' => 'get', - 'ramAction' => [ - 'action' => 'esa:ListESAIPInfo', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'DescribeKvAccountStatus', - 'description' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:DescribeKvAccountStatus', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'UpdatePage', - 'description' => '', - 'operationType' => 'update', - 'ramAction' => [ - 'action' => 'esa:UpdatePage', - 'authLevel' => 'resource', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'UpdateUserDeliveryTask', - 'description' => '', - 'operationType' => 'update', - 'ramAction' => [ - 'action' => 'esa:UpdateUserDeliveryTask', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'ListRoutineRelatedRecords', - 'description' => '', - 'operationType' => 'list', - 'ramAction' => [ - 'action' => 'esa:ListRoutineRelatedRecords', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => '', - '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' => 'All Resource', - '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' => '', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'DescribeEdgeContainerAppStats', - 'description' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:DescribeEdgeContainerAppStats', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'UpdateUserWafRuleset', - 'description' => '', - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'esa:UpdateUserWafRuleset', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'UpdateRewriteUrlRule', - 'description' => '', - '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' => 'All Resource', - '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' => 'All Resource', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'CreateHttpIncomingRequestHeaderModificationRule', - 'description' => '', - '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' => '', - 'operationType' => 'list', - 'ramAction' => [ - 'action' => 'esa:ListWafTemplateRules', - 'authLevel' => 'resource', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'ESA', - 'resourceType' => 'All Resource', - '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' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - [ - 'apiName' => 'DeleteHttpsBasicConfiguration', - 'description' => '', - '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' => '', - '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}:', - ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEdgeRoutinePlans'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckUserProjectName'], + ['threshold' => '10', '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' => 'UpdateRedirectRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUrlObservation'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstanceQuotasWithUsage'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRecord'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHttpIncomingRequestHeaderModificationRule'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRoutine'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHttpDDoSIntelligentRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWafRulesets'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLists'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEdgeContainerAppRecords'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ActivateClientCertificate'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteKv'], + ['threshold' => '100', 'countWindow' => 3600, 'regionId' => '*', 'api' => 'CreateCustomHostname'], + ['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' => 'DescribeDdosMaxBurstGbps'], + ['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' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListESAIPInfo'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLoadBalancerOriginStatus'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHttpRequestHeaderModificationRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSiteCoverage'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSiteCustomLog'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PurchaseRatePlan'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCnameFlattening'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSite'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWafRules'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadOriginClientCertificate'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNetworkOptimization'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateImageTransform'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PurgeCaches'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPage'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateHttpsApplicationConfiguration'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWafFilter'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserRoutines'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRoutineCodeVersion'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRoutineRelatedRecords'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTransportLayerApplication'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHttpIncomingResponseHeaderModificationRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUserDeliveryTaskStatus'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUrlObservation'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListVideoProcessings'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWafRuleset'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteScheduledPreloadExecution'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetClientCaCertificate'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApplyCertificate'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetScheduledPreloadJob'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchGetExpressionFields'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTransportLayerApplication'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableCustomScenePolicy'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCustomHostname'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateHttpIncomingResponseHeaderModificationRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCertificateQuota'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOriginPools'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeactivateVersionManagement'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstanceQuotas'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIPv6'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomResponseCodeRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWaitingRoomEvents'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteKeylessServer'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRoutineStagingCodeUploadInfo'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHttpIncomingResponseHeaderModificationRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWaitingRooms'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRoutineRelatedRecord'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWafQuota'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserWafRulesets'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckSiteName'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetKvDetail'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetHttpDDoSAttackProtection'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchCreateRecords'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHttpResponseHeaderModificationRules'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSiteAccessType'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSitePause'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckSiteProjectName'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomResponseCodeRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRewriteUrlRules'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOriginClientCertificateHostnames'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateImageTransform'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListKvs'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOriginPool'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWaitingRoomEvent'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWafRule'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApiSchemaUsage'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeClientCertificate'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePreloadTasks'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetScheduledPreloadJob'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCacheReserveSpecification'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSiteVanityNS'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomHostname'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWaitingRoomEvent'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSiteCustomLog'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCompressionRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateVideoProcessing'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePage'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEdgeContainerDeployRegions'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetHttpDDoSAttackRuleAction'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWafRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLoadBalancer'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchDeleteKv'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSiteWafSettings'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRealtimeDeliveryField'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHttpIncomingRequestHeaderModificationRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateNetworkOptimization'], + ['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' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSite'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLoadBalancer'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRoutineCodeVersion'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ActivateVersionManagement'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSiteDeliveryTasks'], + ['threshold' => '6', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseInstance'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEdgeContainerAppResourceReserve'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSiteDeliveryTask'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEdgeContainerAppStats'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUrlObservationData'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRecords'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWaitingRoom'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCnameFlattening'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSiteLogDeliveryQuota'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCompressionRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLoadBalancer'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEdgeContainerAppResourceCapacity'], + ['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' => 'DeleteClientCaCertificate'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCrossBorderOptimization'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOriginClientCertificates'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPurgeQuota'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishEdgeContainerAppVersion'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHttpsBasicConfigurations'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateHttpRequestHeaderModificationRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSiteDeliveryTask'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetHttpDDoSAttackRuleStatus'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetClientCertificateHostnames'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomHostnames'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEdgeContainerApp'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEdgeContainerApps'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWaitingRoomRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHttpDDoSIntelligentAclRules'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCompressionRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomScenePolicy'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRedirectRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomScenePolicy'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCertificatesByRecord'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOriginCaCertificates'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserDeliveryTasks'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUserDeliveryTask'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadOriginCaCertificate'], + ['threshold' => '10', 'countWindow' => 10, 'regionId' => '*', 'api' => 'DescribeSiteTimeSeriesData'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOriginRules'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUploadTask'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomResponseCodeRule'], + ['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' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePage'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWaitingRoomRules'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRecord'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomScenePolicies'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetManagedTransform'], + ['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' => 'DescribeHttpDDoSAttackProtection'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSiteRoutes'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPerformanceDataCollection'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUserWafRuleset'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHttpsBasicConfiguration'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCacheRule'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSiteOriginClientCertificates'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenErService'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyCustomHostname'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRoutineRelatedRecord'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEdgeContainerLogs'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRedirectRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHttpsBasicConfiguration'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUrlObservation'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateOriginRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEdgeContainerRecords'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateOriginProtectionIpWhiteList'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRewriteUrlRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLoadBalancer'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEdgeContainerAppResourceReserve'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEdgeContainerAppStatus'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUserWafRuleset'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEdgeContainerTerminal'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteImageTransform'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCacheReserveInstances'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWafRule'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomResponseCodeRules'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSeoBypass'], + ['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' => 'DescribeSiteLogs'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateKvNamespace'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSites'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCacheRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTransportLayerApplications'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTransportLayerApplication'], + ['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' => 'DeleteOriginPool'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWafRuleset'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOriginProtection'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOriginProtection'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetKeylessServer'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRecord'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetList'], + ['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' => 'ListEdgeRoutineRecords'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetKeylessServer'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRoutineRoute'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BlockObject'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNetworkOptimizations'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteClientCertificate'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTieredCache'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRoutineCodeDeployment'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetClientCertificate'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRoutine'], + ['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' => 'GetTieredCache'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCompressionRule'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApplyCustomHostnameCertificate'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHttpIncomingResponseHeaderModificationRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUrlObservations'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSiteDeliveryTask'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomHostname'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUserDeliveryTask'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSiteOriginClientCertificate'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUserWafRuleset'], + ['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' => 'VerifySite'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUserLogDeliveryQuota'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserRatePlanInstances'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEdgeContainerApp'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateHttpResponseHeaderModificationRule'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteOriginCaCertificate'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUploadTasks'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDdosMaxBurstGbps'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateOriginPool'], + ['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' => 'CreateSiteCustomLog'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOriginCaCertificate'], + ['threshold' => '100', 'countWindow' => 3600, 'regionId' => '*', 'api' => 'CreateSite'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSeoBypass'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchDeleteKvWithHighCapacity'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteList'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWafManagedRules'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePerformanceDataCollection'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSiteCurrentNS'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEdgeContainerAppImageSecret'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCertificate'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableCustomScenePolicy'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHttpsBasicConfiguration'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEdgeContainerAppResourceStatus'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetKvAccount'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHttpsApplicationConfigurations'], + ['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' => 'UpdateRoutineConfigDescription'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListClientCertificates'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetCertificate'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWaitingRoom'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateClientCertificate'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadSiteOriginClientCertificate'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDDoSBpsList'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteVideoProcessing'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEdgeContainerAppLogRiver'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHttpRequestHeaderModificationRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRewriteUrlRule'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateHttpIncomingRequestHeaderModificationRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUserDeliveryTask'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWaitingRoomRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWaitingRoomEvent'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteScheduledPreloadJob'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSiteNameExclusive'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCacheRule'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListKeylessServers'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEdgeContainerAppImageSecrets'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetClientCertificateHostnames'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOriginRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadClientCaCertificate'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLoadBalancerRegions'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAutomaticFrequencyControlConfig'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUserDeliveryTask'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateHttpsBasicConfiguration'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWafTemplateRules'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateManagedTransform'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRewriteUrlRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAutomaticFrequencyControlConfig'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEdgeContainerAppImageSecret'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetKv'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTransportLayerApplication'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CommitRoutineStagingCode'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHttpDDoSAttackIntelligentProtection'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHttpDDoSAttackRules'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCacheTag'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRoutineRoute'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDevelopmentMode'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHttpIncomingRequestHeaderModificationRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEdgeContainerAppVersions'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEdgeContainerAppRecord'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PreloadCaches'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetVideoProcessing'], + ['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' => 'DescribeHttpDDoSIntelligentRateLimitRules'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIPv6'], + ['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' => 'UpdateWaitingRoomRule'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRoutineRoute'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSiteOriginClientCertificate'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateOriginProtection'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRoutineRoute'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHttpRequestHeaderModificationRules'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchUpdateWafRules'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDDoSAllEventList'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateHttpsApplicationConfiguration'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRoutine'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCustomResponseCodeRule'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCustomScenePolicy'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWafRuleset'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchPutKvWithHighCapacity'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateScheduledPreloadExecutions'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListImageTransforms'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEdgeContainerAppRecord'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateList'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateScheduledPreloadExecution'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHttpsApplicationConfiguration'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUserWafRuleset'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartScheduledPreloadExecution'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePurgeTasks'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateScheduledPreloadJob'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLoadBalancers'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateVideoProcessing'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHttpIncomingRequestHeaderModificationRules'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSitePause'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCacheRule'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHttpIncomingResponseHeaderModificationRules'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchPutKv'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRoutineCodeVersions'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRecord'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDDoSInstances'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetOriginClientCertificateHostnames'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWafRuleset'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchCreateWafRules'], ], ], + 'ram' => [ + 'productCode' => 'ESA', + 'productName' => 'Edge Security Acceleration', + 'ramCodes' => ['esa'], + 'ramLevel' => 'SERVICE', + 'ramConditions' => [], + 'ramActions' => [], + 'resourceTypes' => [], + ], ]; -- cgit v1.2.3